From 1095862c2b768833159541189a03f235497551c9 Mon Sep 17 00:00:00 2001 From: Andrew Jiang Date: Mon, 30 Sep 2024 14:55:01 -0400 Subject: [PATCH] chore: implement api-definition migrator and add fixtures (#1552) --- .github/workflows/ci.yml | 3 + .gitignore | 1 + .../fdr/definition/api/latest/endpoint.yml | 17 +- fern/apis/fdr/definition/api/latest/type.yml | 7 +- .../fdr/definition/api/latest/webhook.yml | 7 +- .../fdr/definition/api/latest/websocket.yml | 11 +- package.json | 2 +- packages/commons/core-utils/package.json | 32 +- .../commons/core-utils/src/assertNever.ts | 2 + packages/commons/core-utils/src/identity.ts | 2 + .../core-utils/src/objects/isPlainObject.ts | 2 + packages/commons/core-utils/src/titleCase.ts | 2 + .../commons/core-utils/src/unknownToString.ts | 2 + .../core-utils/src/visitDiscriminatedUnion.ts | 2 + packages/fdr-sdk/package.json | 4 + .../__test__/__snapshots__/hume.test.ts.snap | 0 .../no-version-no-tabs.test.ts.snap | 0 .../no-version-yes-tabs.test.ts.snap | 0 .../__snapshots__/octoai.test.ts.snap | 0 .../__snapshots__/polytomic.test.ts.snap | 0 .../__snapshots__/primer.test.ts.snap | 0 .../__snapshots__/uploadcare.test.ts.snap | 0 .../yes-version-no-tabs.test.ts.snap | 0 .../yes-version-yes-tabs.test.ts.snap | 0 .../__test__/fixtures.test.ts | 43 +- .../__test__/fixtures/assemblyai.json | 14 +- .../__test__/fixtures/astronomer.json | 6 +- .../__test__/fixtures/humanloop.json | 0 .../__test__/fixtures/hume.json | 16 +- .../__test__/fixtures/no-version-no-tabs.json | 0 .../fixtures/no-version-yes-tabs.json | 0 .../__test__/fixtures/octoai.json | 34 +- .../__test__/fixtures/polytomic.json | 5 +- .../__test__/fixtures/primer.json | 20 +- .../__test__/fixtures/uploadcare.json | 8 +- .../fixtures/yes-version-no-tabs.json | 0 .../fixtures/yes-version-yes-tabs.json | 0 .../{navigation => }/__test__/hume.test.ts | 4 +- .../__test__/no-version-no-tabs.test.ts | 4 +- .../__test__/no-version-yes-tabs.test.ts | 4 +- .../{navigation => }/__test__/octoai.test.ts | 4 +- ...-72c824a6-ca97-4592-a585-266e983022de.json | 1280 + .../output/assemblyai/apiDefinitions.json | 12844 ++ .../__test__/output/assemblyai/node.json | 0 .../output/assemblyai/orphanedNodes.json | 0 .../assemblyai/orphanedNodesWithContent.json | 0 .../__test__/output/assemblyai/pageIds.json | 0 .../__test__/output/assemblyai/sitemap.json | 0 .../output/assemblyai/slugs-pages.json | 0 .../output/assemblyai/slugs-sitemap.json | 0 .../__test__/output/assemblyai/slugs.json | 0 .../output/assemblyai/versionNodes.json | 0 ...-7bbd8b60-d410-43c1-bda4-3c0813a4fbb7.json | 1648 + ...-a4030141-9ea5-4ac9-8d2b-f44b815980a8.json | 1135 + .../output/astronomer/apiDefinitions.json | 27771 ++++ .../__test__/output/astronomer/node.json | 0 .../output/astronomer/orphanedNodes.json | 0 .../astronomer/orphanedNodesWithContent.json | 0 .../__test__/output/astronomer/pageIds.json | 0 .../__test__/output/astronomer/sitemap.json | 0 .../output/astronomer/slugs-pages.json | 0 .../output/astronomer/slugs-sitemap.json | 0 .../__test__/output/astronomer/slugs.json | 0 .../output/astronomer/versionNodes.json | 0 ...-8099ff24-8ade-48d5-a54a-8d2d1831d806.json | 2009 + ...-d8feb9f1-c5b3-4935-9375-ad1f1826d72d.json | 2484 + .../output/humanloop/apiDefinitions.json | 78452 +++++++++++ .../__test__/output/humanloop/node.json | 0 .../output/humanloop/orphanedNodes.json | 0 .../humanloop/orphanedNodesWithContent.json | 0 .../__test__/output/humanloop/pageIds.json | 0 .../__test__/output/humanloop/sitemap.json | 0 .../output/humanloop/slugs-pages.json | 0 .../output/humanloop/slugs-sitemap.json | 0 .../__test__/output/humanloop/slugs.json | 0 .../output/humanloop/versionNodes.json | 0 ...-8b03e44c-d4e2-4613-a138-e25b8c65c3cb.json | 754 + ...-bcb7826e-ffd6-4440-b3de-6bf37440c3e2.json | 1039 + ...-e810f56e-df97-4af2-bdaa-659077e1948e.json | 858 + .../__test__/output/hume/apiDefinitions.json | 22417 ++++ .../__test__/output/hume/node.json | 0 .../__test__/output/hume/orphanedNodes.json | 0 .../output/hume/orphanedNodesWithContent.json | 0 .../__test__/output/hume/pageIds.json | 0 .../__test__/output/hume/sitemap.json | 0 .../__test__/output/hume/slugs-pages.json | 0 .../__test__/output/hume/slugs-sitemap.json | 0 .../__test__/output/hume/slugs.json | 0 .../__test__/output/hume/versionNodes.json | 0 .../no-version-no-tabs/apiDefinitions.json} | 0 .../output/no-version-no-tabs/node.json | 0 .../no-version-no-tabs/orphanedNodes.json | 0 .../orphanedNodesWithContent.json | 0 .../output/no-version-no-tabs/pageIds.json | 0 .../output/no-version-no-tabs/sitemap.json | 0 .../no-version-no-tabs/slugs-pages.json | 0 .../no-version-no-tabs/slugs-sitemap.json | 0 .../output/no-version-no-tabs/slugs.json | 0 .../no-version-no-tabs/versionNodes.json | 0 .../no-version-yes-tabs/apiDefinitions.json} | 0 .../output/no-version-yes-tabs/node.json | 0 .../no-version-yes-tabs/orphanedNodes.json | 0 .../orphanedNodesWithContent.json | 0 .../output/no-version-yes-tabs/pageIds.json | 0 .../output/no-version-yes-tabs/sitemap.json | 0 .../no-version-yes-tabs/slugs-pages.json | 0 .../no-version-yes-tabs/slugs-sitemap.json | 0 .../output/no-version-yes-tabs/slugs.json | 0 .../no-version-yes-tabs}/versionNodes.json | 0 ...-270fcb14-fecb-45b5-8075-3e207a0d4b31.json | 1080 + ...-2eeac53f-90cc-492b-9d29-e3ed711d7704.json | 147 + ...-cb786748-d42f-427d-9c21-00e6c59bd56c.json | 338 + .../output/octoai/apiDefinitions.json | 29241 ++++ .../__test__/output/octoai/node.json | 0 .../__test__/output/octoai/orphanedNodes.json | 0 .../octoai}/orphanedNodesWithContent.json | 0 .../__test__/output/octoai/pageIds.json | 0 .../__test__/output/octoai/sitemap.json | 0 .../__test__/output/octoai/slugs-pages.json | 0 .../__test__/output/octoai/slugs-sitemap.json | 0 .../__test__/output/octoai/slugs.json | 0 .../output/octoai}/versionNodes.json | 0 ...-4f9d4e39-a928-4c8a-b9d0-308434722f10.json | 3576 + ...-9212af81-e9e3-43ce-bb7e-997fe422dfe3.json | 352 + ...-9b972bf3-4f92-48dd-8a15-386f34ae82e1.json | 2309 + ...-d051ed90-658a-4822-a2ee-f77a495b9085.json | 3693 + .../output/polytomic/apiDefinitions.json | 102351 +++++++++++++++ .../__test__/output/polytomic/node.json | 0 .../output/polytomic/orphanedNodes.json | 0 .../polytomic}/orphanedNodesWithContent.json | 0 .../__test__/output/polytomic/pageIds.json | 0 .../__test__/output/polytomic/sitemap.json | 0 .../output/polytomic/slugs-pages.json | 0 .../output/polytomic/slugs-sitemap.json | 0 .../__test__/output/polytomic/slugs.json | 0 .../output/polytomic/versionNodes.json | 0 ...-090e0b31-c453-4f41-8269-845a6e8a461f.json | 2553 + ...-0d20b529-65ad-4f2b-99a5-562a73e0b3c9.json | 2656 + ...-3e1141df-b4bc-4dab-9542-53cf91851645.json | 817 + ...-7ed504c0-fc2e-4a52-b3fd-b277869eda14.json | 1252 + ...-c5629660-3984-4ce0-989e-9c6fb0df36d9.json | 945 + ...-ca56f687-5be3-4661-aeed-674a0f1f7193.json | 945 + ...-fe590ab9-f9e7-4719-8ec5-b595affff88d.json | 1194 + .../output/primer/apiDefinitions.json | 63437 +++++++++ .../__test__/output/primer/node.json | 0 .../__test__/output/primer/orphanedNodes.json | 0 .../primer}/orphanedNodesWithContent.json | 0 .../__test__/output/primer/pageIds.json | 0 .../__test__/output/primer/sitemap.json | 0 .../__test__/output/primer/slugs-pages.json | 0 .../__test__/output/primer/slugs-sitemap.json | 0 .../__test__/output/primer/slugs.json | 0 .../__test__/output/primer/versionNodes.json | 0 ...-15c16fe3-9b9c-4a04-ae4f-f9749d504bc7.json | 574 + ...-6e1b77b7-26ce-4bba-9544-a24a9b3519dc.json | 60 + ...-fb019a78-a773-4315-9c7b-6dcb585d6b30.json | 1415 + .../output/uploadcare/apiDefinitions.json | 18525 +++ .../__test__/output/uploadcare/node.json | 0 .../output/uploadcare/orphanedNodes.json | 0 .../uploadcare}/orphanedNodesWithContent.json | 0 .../__test__/output/uploadcare/pageIds.json | 0 .../__test__/output/uploadcare/sitemap.json | 0 .../output/uploadcare/slugs-pages.json | 0 .../output/uploadcare/slugs-sitemap.json | 0 .../__test__/output/uploadcare/slugs.json | 0 .../output/uploadcare/versionNodes.json | 1 + .../yes-version-no-tabs/apiDefinitions.json | 1 + .../output/yes-version-no-tabs/node.json | 0 .../yes-version-no-tabs/orphanedNodes.json | 0 .../orphanedNodesWithContent.json | 1 + .../output/yes-version-no-tabs/pageIds.json | 0 .../output/yes-version-no-tabs/sitemap.json | 0 .../yes-version-no-tabs/slugs-pages.json | 0 .../yes-version-no-tabs/slugs-sitemap.json | 0 .../output/yes-version-no-tabs/slugs.json | 0 .../yes-version-no-tabs/versionNodes.json | 0 .../yes-version-yes-tabs/apiDefinitions.json | 1 + .../output/yes-version-yes-tabs/node.json | 0 .../yes-version-yes-tabs/orphanedNodes.json | 0 .../orphanedNodesWithContent.json | 0 .../output/yes-version-yes-tabs/pageIds.json | 0 .../output/yes-version-yes-tabs/sitemap.json | 0 .../yes-version-yes-tabs/slugs-pages.json | 0 .../yes-version-yes-tabs/slugs-sitemap.json | 0 .../output/yes-version-yes-tabs/slugs.json | 0 .../yes-version-yes-tabs/versionNodes.json | 0 .../__test__/polytomic.test.ts | 4 +- .../{navigation => }/__test__/primer.test.ts | 4 +- .../{navigation => }/__test__/readFixtures.ts | 2 +- .../__test__/testGetAllUrlsFromDocsConfig.ts | 4 +- .../__test__/testGetNavigationRoot.ts | 4 +- .../__test__/uploadcare.test.ts | 4 +- .../__test__/yes-version-no-tabs.test.ts | 4 +- .../__test__/yes-version-yes-tabs.test.ts | 4 +- .../__test__/availability.test.ts | 21 + .../src/api-definition/__test__/join.test.ts | 282 + .../src/api-definition/__test__/prune.test.ts | 244 + .../api-definition/__test__/unwrap.test.ts | 467 + .../src/api-definition/availability.ts | 38 + packages/fdr-sdk/src/api-definition/const.ts | 5 + packages/fdr-sdk/src/api-definition/index.ts | 9 +- packages/fdr-sdk/src/api-definition/join.ts | 61 + packages/fdr-sdk/src/api-definition/latest.ts | 3 + .../src/api-definition/migrators/v1ToV2.ts | 695 + packages/fdr-sdk/src/api-definition/prune.ts | 143 + .../api-definition/snippets/HttpRequest.ts | 153 + .../src/api-definition/snippets/curl.ts | 114 + .../fdr-sdk/src/api-definition/sort-keys.ts | 135 + .../fdr-sdk/src/api-definition/transformer.ts | 535 + .../src/api-definition/typeid-visitor.ts | 148 + packages/fdr-sdk/src/api-definition/types.ts | 10 + packages/fdr-sdk/src/api-definition/unwrap.ts | 292 + .../endpoint/types/EndpointDefinition.ts | 3 +- .../endpoint/types/ExampleEndpointCall.ts | 12 +- .../endpoint/types/HttpRequestBodyShape.ts | 6 +- .../endpoint/types/HttpResponseBodyShape.ts | 6 +- .../type/types/DiscriminatedUnionType.ts | 2 +- .../type/types/DiscriminatedUnionVariant.ts | 4 +- .../resources/type/types/FormDataRequest.ts | 1 - .../webhook/types/WebhookDefinition.ts | 9 +- .../types/ExampleWebSocketSession.ts | 10 +- .../websocket/types/WebSocketChannel.ts | 3 +- .../converters/db/convertAPIDefinitionToDb.ts | 5 +- .../db/convertDocsDefinitionToDb.ts | 2 +- .../examples/generateEndpointExampleCall.ts | 2 +- .../db/examples/generateHttpBodyExample.ts | 2 +- .../db/upgrade/migrateDocsDbDefinition.ts | 2 +- .../read/convertDbAPIDefinitionToRead.ts | 2 +- .../read/convertDbDocsConfigToRead.ts | 2 +- .../src/converters/utils/assertNever.ts | 6 - packages/fdr-sdk/src/index.ts | 2 - .../src/navigation/ApiTypeIdVisitor.ts | 2 +- .../src/navigation/migrators/v1ToV2.ts | 3 +- .../src/navigation/utils/createBreadcrumbs.ts | 2 +- .../src/navigation/utils/getApiReferenceId.ts | 2 +- .../navigation/versions/latest/getPageId.ts | 2 +- .../versions/latest/traverseNavigation.ts | 2 +- .../ApiReferenceNavigationConverter.ts | 3 +- .../converters/NavigationConfigConverter.ts | 4 +- .../navigation/versions/v1/followRedirect.ts | 2 +- .../src/navigation/versions/v1/getPageId.ts | 2 +- .../versions/v1/traverseNavigation.ts | 2 +- packages/fdr-sdk/src/utils/assertNever.ts | 6 - packages/fdr-sdk/src/utils/index.ts | 4 - packages/fdr-sdk/src/utils/isPlainObject.ts | 18 - packages/fdr-sdk/src/utils/specialTokens.ts | 361 - packages/fdr-sdk/src/utils/titleCase.ts | 19 - .../src/utils/visitDiscriminatedUnion.ts | 33 - packages/fdr-sdk/tsconfig.json | 3 +- .../stringifyHttpRequestExampleToCurl.test.ts | 39 +- .../ui/app/src/hooks/usePlaygroundSettings.ts | 2 +- .../endpoint/PlaygroundEndpointForm.tsx | 2 +- .../PlaygroundEndpointMultipartForm.tsx | 2 +- .../app/src/playground/utils/auth-headers.ts | 3 +- .../src/playground/utils/default-values.ts | 2 +- .../app/src/playground/utils/match-typeref.ts | 2 +- packages/ui/app/src/playground/utils/oauth.ts | 4 +- .../app/src/search/content/FieldRecordV1.tsx | 2 +- .../src/server/withInitialProps.ts | 2 +- pnpm-lock.yaml | 9 + servers/fdr/package.json | 1 + .../endpoint/types/EndpointDefinition.d.ts | 2 +- .../endpoint/types/ExampleEndpointCall.d.ts | 12 +- .../endpoint/types/HttpRequestBodyShape.d.ts | 6 +- .../endpoint/types/HttpResponseBodyShape.d.ts | 6 +- .../type/types/DiscriminatedUnionType.d.ts | 2 +- .../type/types/DiscriminatedUnionVariant.d.ts | 3 +- .../resources/type/types/FormDataRequest.d.ts | 1 - .../webhook/types/WebhookDefinition.d.ts | 8 +- .../types/ExampleWebSocketSession.d.ts | 10 +- .../websocket/types/WebSocketChannel.d.ts | 2 +- .../algolia/AlgoliaSearchRecordGenerator.ts | 3 +- .../algolia/AlgoliaSearchRecordGeneratorV2.ts | 3 +- servers/fdr/tsconfig.json | 3 + 274 files changed, 393829 insertions(+), 651 deletions(-) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/hume.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/no-version-no-tabs.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/no-version-yes-tabs.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/octoai.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/polytomic.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/primer.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/uploadcare.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/yes-version-no-tabs.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/__snapshots__/yes-version-yes-tabs.test.ts.snap (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures.test.ts (76%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/assemblyai.json (99%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/astronomer.json (99%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/humanloop.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/hume.json (99%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/no-version-no-tabs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/no-version-yes-tabs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/octoai.json (99%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/polytomic.json (99%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/primer.json (99%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/uploadcare.json (99%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/yes-version-no-tabs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/fixtures/yes-version-yes-tabs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/hume.test.ts (86%) rename packages/fdr-sdk/src/{navigation => }/__test__/no-version-no-tabs.test.ts (86%) rename packages/fdr-sdk/src/{navigation => }/__test__/no-version-yes-tabs.test.ts (87%) rename packages/fdr-sdk/src/{navigation => }/__test__/octoai.test.ts (88%) create mode 100644 packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitionKeys-72c824a6-ca97-4592-a585-266e983022de.json create mode 100644 packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/assemblyai/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-7bbd8b60-d410-43c1-bda4-3c0813a4fbb7.json create mode 100644 packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-a4030141-9ea5-4ac9-8d2b-f44b815980a8.json create mode 100644 packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/astronomer/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-8099ff24-8ade-48d5-a54a-8d2d1831d806.json create mode 100644 packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-d8feb9f1-c5b3-4935-9375-ad1f1826d72d.json create mode 100644 packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/humanloop/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-8b03e44c-d4e2-4613-a138-e25b8c65c3cb.json create mode 100644 packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-bcb7826e-ffd6-4440-b3de-6bf37440c3e2.json create mode 100644 packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-e810f56e-df97-4af2-bdaa-659077e1948e.json create mode 100644 packages/fdr-sdk/src/__test__/output/hume/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/hume/versionNodes.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/no-version-no-tabs/orphanedNodesWithContent.json => __test__/output/no-version-no-tabs/apiDefinitions.json} (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/octoai => __test__/output/no-version-no-tabs}/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-no-tabs/versionNodes.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/no-version-yes-tabs/versionNodes.json => __test__/output/no-version-yes-tabs/apiDefinitions.json} (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/no-version-yes-tabs/slugs.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/octoai => __test__/output/no-version-yes-tabs}/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-270fcb14-fecb-45b5-8075-3e207a0d4b31.json create mode 100644 packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-2eeac53f-90cc-492b-9d29-e3ed711d7704.json create mode 100644 packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-cb786748-d42f-427d-9c21-00e6c59bd56c.json create mode 100644 packages/fdr-sdk/src/__test__/output/octoai/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/octoai/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/octoai/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/polytomic => __test__/output/octoai}/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/octoai/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/octoai/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/octoai/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/octoai/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/octoai/slugs.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/uploadcare => __test__/output/octoai}/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-4f9d4e39-a928-4c8a-b9d0-308434722f10.json create mode 100644 packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9212af81-e9e3-43ce-bb7e-997fe422dfe3.json create mode 100644 packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9b972bf3-4f92-48dd-8a15-386f34ae82e1.json create mode 100644 packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-d051ed90-658a-4822-a2ee-f77a495b9085.json create mode 100644 packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/primer => __test__/output/polytomic}/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/polytomic/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-090e0b31-c453-4f41-8269-845a6e8a461f.json create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-0d20b529-65ad-4f2b-99a5-562a73e0b3c9.json create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-3e1141df-b4bc-4dab-9542-53cf91851645.json create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-7ed504c0-fc2e-4a52-b3fd-b277869eda14.json create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-c5629660-3984-4ce0-989e-9c6fb0df36d9.json create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-ca56f687-5be3-4661-aeed-674a0f1f7193.json create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-fe590ab9-f9e7-4719-8ec5-b595affff88d.json create mode 100644 packages/fdr-sdk/src/__test__/output/primer/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/uploadcare => __test__/output/primer}/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/primer/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-15c16fe3-9b9c-4a04-ae4f-f9749d504bc7.json create mode 100644 packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-6e1b77b7-26ce-4bba-9544-a24a9b3519dc.json create mode 100644 packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-fb019a78-a773-4315-9c7b-6dcb585d6b30.json create mode 100644 packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/uploadcare/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/uploadcare/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation/__test__/output/yes-version-no-tabs => __test__/output/uploadcare}/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/uploadcare/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/uploadcare/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/uploadcare/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/uploadcare/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/uploadcare/slugs.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/uploadcare/versionNodes.json create mode 100644 packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/orphanedNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/orphanedNodesWithContent.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-no-tabs/versionNodes.json (100%) create mode 100644 packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/apiDefinitions.json rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/node.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/orphanedNodes.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/orphanedNodesWithContent.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/pageIds.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/slugs-pages.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/slugs-sitemap.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/slugs.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/output/yes-version-yes-tabs/versionNodes.json (100%) rename packages/fdr-sdk/src/{navigation => }/__test__/polytomic.test.ts (87%) rename packages/fdr-sdk/src/{navigation => }/__test__/primer.test.ts (86%) rename packages/fdr-sdk/src/{navigation => }/__test__/readFixtures.ts (87%) rename packages/fdr-sdk/src/{navigation => }/__test__/testGetAllUrlsFromDocsConfig.ts (79%) rename packages/fdr-sdk/src/{navigation => }/__test__/testGetNavigationRoot.ts (86%) rename packages/fdr-sdk/src/{navigation => }/__test__/uploadcare.test.ts (87%) rename packages/fdr-sdk/src/{navigation => }/__test__/yes-version-no-tabs.test.ts (88%) rename packages/fdr-sdk/src/{navigation => }/__test__/yes-version-yes-tabs.test.ts (88%) create mode 100644 packages/fdr-sdk/src/api-definition/__test__/availability.test.ts create mode 100644 packages/fdr-sdk/src/api-definition/__test__/join.test.ts create mode 100644 packages/fdr-sdk/src/api-definition/__test__/prune.test.ts create mode 100644 packages/fdr-sdk/src/api-definition/__test__/unwrap.test.ts create mode 100644 packages/fdr-sdk/src/api-definition/availability.ts create mode 100644 packages/fdr-sdk/src/api-definition/const.ts create mode 100644 packages/fdr-sdk/src/api-definition/join.ts create mode 100644 packages/fdr-sdk/src/api-definition/latest.ts create mode 100644 packages/fdr-sdk/src/api-definition/migrators/v1ToV2.ts create mode 100644 packages/fdr-sdk/src/api-definition/prune.ts create mode 100644 packages/fdr-sdk/src/api-definition/snippets/HttpRequest.ts create mode 100644 packages/fdr-sdk/src/api-definition/snippets/curl.ts create mode 100644 packages/fdr-sdk/src/api-definition/sort-keys.ts create mode 100644 packages/fdr-sdk/src/api-definition/transformer.ts create mode 100644 packages/fdr-sdk/src/api-definition/typeid-visitor.ts create mode 100644 packages/fdr-sdk/src/api-definition/types.ts create mode 100644 packages/fdr-sdk/src/api-definition/unwrap.ts delete mode 100644 packages/fdr-sdk/src/converters/utils/assertNever.ts delete mode 100644 packages/fdr-sdk/src/utils/assertNever.ts delete mode 100644 packages/fdr-sdk/src/utils/isPlainObject.ts delete mode 100644 packages/fdr-sdk/src/utils/specialTokens.ts delete mode 100644 packages/fdr-sdk/src/utils/titleCase.ts delete mode 100644 packages/fdr-sdk/src/utils/visitDiscriminatedUnion.ts diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2a3938da9a..efd9e9aada 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -63,6 +63,9 @@ jobs: - name: Install uses: ./.github/actions/install + - name: Build components + run: pnpm turbo --filter=@fern-ui/components compile + - name: Run Chromatic uses: chromaui/action@latest # Chromatic CI config: https://www.chromatic.com/docs/github-actions/ diff --git a/.gitignore b/.gitignore index 30ffe5c318..5b45f724ef 100644 --- a/.gitignore +++ b/.gitignore @@ -53,6 +53,7 @@ lerna-debug.log* /playwright/.cache/ *storybook.log +storybook-static/ #ide .idea/ diff --git a/fern/apis/fdr/definition/api/latest/endpoint.yml b/fern/apis/fdr/definition/api/latest/endpoint.yml index 5b177717c5..685923dd4c 100644 --- a/fern/apis/fdr/definition/api/latest/endpoint.yml +++ b/fern/apis/fdr/definition/api/latest/endpoint.yml @@ -18,6 +18,7 @@ types: extends: - commons.WithDescription - commons.WithAvailability + - commons.WithNamespace properties: id: rootCommons.EndpointId # or original endpoint id? method: rootCommons.HttpMethod @@ -50,7 +51,7 @@ types: HttpRequestBodyShape: union: object: type.ObjectType - reference: type.TypeReference + alias: type.TypeReference bytes: type.BytesRequest formData: type.FormDataRequest @@ -64,7 +65,7 @@ types: HttpResponseBodyShape: union: object: type.ObjectType - reference: type.TypeReference + alias: type.TypeReference fileDownload: FileDownloadResponseBodyShape streamingText: {} stream: StreamResponse @@ -96,15 +97,15 @@ types: ExampleEndpointCall: extends: commons.WithDescription properties: - name: optional path: string - pathParameters: map - queryParameters: map - headers: map - requestBody: optional responseStatusCode: integer + name: optional + pathParameters: optional> + queryParameters: optional> + headers: optional> + requestBody: optional responseBody: optional - snippets: list + snippets: optional>> CodeSnippet: extends: commons.WithDescription diff --git a/fern/apis/fdr/definition/api/latest/type.yml b/fern/apis/fdr/definition/api/latest/type.yml index a61267e8be..0478ffba89 100644 --- a/fern/apis/fdr/definition/api/latest/type.yml +++ b/fern/apis/fdr/definition/api/latest/type.yml @@ -87,24 +87,23 @@ types: DiscriminatedUnionType: properties: - discriminant: string + discriminant: rootCommons.PropertyKey variants: list DiscriminatedUnionVariant: extends: - commons.WithDescription - commons.WithAvailability + - ObjectType properties: discriminantValue: string displayName: optional - additionalProperties: ObjectType FormDataRequest: extends: - commons.WithDescription - commons.WithAvailability properties: - name: string fields: list FormDataField: @@ -114,7 +113,7 @@ types: property: FormDataProperty FormDataProperty: - extends: ObjectProperty + extends: ObjectProperty # has description and availability properties: contentType: optional diff --git a/fern/apis/fdr/definition/api/latest/webhook.yml b/fern/apis/fdr/definition/api/latest/webhook.yml index 53f85b5c3c..c537a00dc6 100644 --- a/fern/apis/fdr/definition/api/latest/webhook.yml +++ b/fern/apis/fdr/definition/api/latest/webhook.yml @@ -11,13 +11,14 @@ types: extends: - commons.WithDescription - commons.WithAvailability + - commons.WithNamespace properties: id: rootCommons.WebhookId method: WebhookHttpMethod path: list - headers: list - payload: WebhookPayload - examples: list + headers: optional> + payload: optional + examples: optional> WebhookPayload: extends: commons.WithDescription diff --git a/fern/apis/fdr/definition/api/latest/websocket.yml b/fern/apis/fdr/definition/api/latest/websocket.yml index 2fa835c5e4..342501ce6d 100644 --- a/fern/apis/fdr/definition/api/latest/websocket.yml +++ b/fern/apis/fdr/definition/api/latest/websocket.yml @@ -18,6 +18,7 @@ types: extends: - commons.WithDescription - commons.WithAvailability + - commons.WithNamespace properties: id: rootCommons.WebSocketId path: list @@ -46,9 +47,9 @@ types: ExampleWebSocketSession: extends: commons.WithDescription properties: - name: optional path: string - pathParameters: map - queryParameters: map - requestHeaders: map - messages: list + name: optional + pathParameters: optional> + queryParameters: optional> + requestHeaders: optional> + messages: optional> diff --git a/package.json b/package.json index 2a4838c42b..72bdb18179 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,7 @@ "docs:build": "turbo docs:build", "docs:start": "turbo docs:start", "docs:e2e": "vitest --run test/docs-e2e/**/* --globals", - "fdr:generate": "pnpm fern generate --api fdr --local && pnpm --filter=@fern-api/fdr-sdk compile" + "fdr:generate": "pnpm fern generate --api fdr --local && pnpm turbo --filter=@fern-api/fdr-sdk compile" }, "devDependencies": { "@babel/core": "^7.23.7", diff --git a/packages/commons/core-utils/package.json b/packages/commons/core-utils/package.json index b3466f38e6..5499ebaf45 100644 --- a/packages/commons/core-utils/package.json +++ b/packages/commons/core-utils/package.json @@ -12,9 +12,37 @@ ], "type": "module", "source": "src/index.ts", - "module": "src/index.ts", "main": "dist/index.js", - "types": "dist/index.d.ts", + "exports": { + "./assertNever": { + "types": "./src/assertNever.ts", + "default": "./dist/assertNever.js" + }, + "./titleCase": { + "types": "./src/titleCase.ts", + "default": "./dist/titleCase.js" + }, + "./unknownToString": { + "types": "./src/unknownToString.ts", + "default": "./dist/unknownToString.js" + }, + "./visitDiscriminatedUnion": { + "types": "./src/visitDiscriminatedUnion.ts", + "default": "./dist/visitDiscriminatedUnion.js" + }, + "./isPlainObject": { + "types": "./src/objects/isPlainObject.ts", + "default": "./dist/objects/isPlainObject.js" + }, + "./identity": { + "types": "./src/identity.ts", + "default": "./dist/identity.js" + }, + ".": { + "types": "./src/index.ts", + "default": "./dist/index.js" + } + }, "sideEffects": false, "scripts": { "clean": "rm -rf ./lib && tsc --build --clean", diff --git a/packages/commons/core-utils/src/assertNever.ts b/packages/commons/core-utils/src/assertNever.ts index e96382acf1..b9d0abd3c5 100644 --- a/packages/commons/core-utils/src/assertNever.ts +++ b/packages/commons/core-utils/src/assertNever.ts @@ -4,3 +4,5 @@ export function assertNever(x: never): never { // eslint-disable-next-line @typescript-eslint/no-empty-function export function assertNeverNoThrow(_: never): void {} + +export default assertNever; diff --git a/packages/commons/core-utils/src/identity.ts b/packages/commons/core-utils/src/identity.ts index ca94c26b7d..b4134ab8c1 100644 --- a/packages/commons/core-utils/src/identity.ts +++ b/packages/commons/core-utils/src/identity.ts @@ -1,3 +1,5 @@ export function identity(value: T): T { return value; } + +export default identity; diff --git a/packages/commons/core-utils/src/objects/isPlainObject.ts b/packages/commons/core-utils/src/objects/isPlainObject.ts index 96272f18e1..b538f2d083 100644 --- a/packages/commons/core-utils/src/objects/isPlainObject.ts +++ b/packages/commons/core-utils/src/objects/isPlainObject.ts @@ -16,3 +16,5 @@ export function isPlainObject(value: unknown): value is Record function isObjectLike(value: unknown) { return typeof value === "object" && value != null; } + +export default isPlainObject; diff --git a/packages/commons/core-utils/src/titleCase.ts b/packages/commons/core-utils/src/titleCase.ts index d2b047ed59..d131d79a3f 100644 --- a/packages/commons/core-utils/src/titleCase.ts +++ b/packages/commons/core-utils/src/titleCase.ts @@ -17,3 +17,5 @@ export function titleCase(name: string): string { const versionedTitle = titleCased.replace(/V\s(\d)/g, "V$1"); return versionedTitle; } + +export default titleCase; diff --git a/packages/commons/core-utils/src/unknownToString.ts b/packages/commons/core-utils/src/unknownToString.ts index fe956bd03e..4d7050dacb 100644 --- a/packages/commons/core-utils/src/unknownToString.ts +++ b/packages/commons/core-utils/src/unknownToString.ts @@ -10,3 +10,5 @@ export function unknownToString(value: unknown, { renderNull = false }: Opts = { } return JSON.stringify(value); } + +export default unknownToString; diff --git a/packages/commons/core-utils/src/visitDiscriminatedUnion.ts b/packages/commons/core-utils/src/visitDiscriminatedUnion.ts index c36b74250c..3f406d134c 100644 --- a/packages/commons/core-utils/src/visitDiscriminatedUnion.ts +++ b/packages/commons/core-utils/src/visitDiscriminatedUnion.ts @@ -31,3 +31,5 @@ export function visitDiscriminatedUnion, }, }; } + +export default visitDiscriminatedUnion; diff --git a/packages/fdr-sdk/package.json b/packages/fdr-sdk/package.json index 69386c0733..4f7a9d1ff7 100644 --- a/packages/fdr-sdk/package.json +++ b/packages/fdr-sdk/package.json @@ -31,6 +31,7 @@ } }, "dependencies": { + "@fern-ui/core-utils": "workspace:*", "dayjs": "^1.11.11", "fast-deep-equal": "^3.1.3", "form-data": "4.0.0", @@ -43,6 +44,9 @@ "ts-essentials": "^10.0.1", "url-join": "5.0.0" }, + "peerDependencies": { + "lodash-es": ">=4" + }, "devDependencies": { "@babel/core": "^7.18.9", "@babel/preset-env": "^7.24.3", diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/hume.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/hume.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/hume.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/hume.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/no-version-no-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/no-version-no-tabs.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/no-version-no-tabs.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/no-version-no-tabs.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/no-version-yes-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/no-version-yes-tabs.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/no-version-yes-tabs.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/no-version-yes-tabs.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/octoai.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/octoai.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/octoai.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/octoai.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/polytomic.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/polytomic.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/polytomic.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/polytomic.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/primer.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/primer.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/primer.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/primer.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/uploadcare.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/uploadcare.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/uploadcare.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/uploadcare.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/yes-version-no-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/yes-version-no-tabs.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/yes-version-no-tabs.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/yes-version-no-tabs.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/yes-version-yes-tabs.test.ts.snap b/packages/fdr-sdk/src/__test__/__snapshots__/yes-version-yes-tabs.test.ts.snap similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/__snapshots__/yes-version-yes-tabs.test.ts.snap rename to packages/fdr-sdk/src/__test__/__snapshots__/yes-version-yes-tabs.test.ts.snap diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures.test.ts b/packages/fdr-sdk/src/__test__/fixtures.test.ts similarity index 76% rename from packages/fdr-sdk/src/navigation/__test__/fixtures.test.ts rename to packages/fdr-sdk/src/__test__/fixtures.test.ts index 57962627bb..9b55ee93b2 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures.test.ts +++ b/packages/fdr-sdk/src/__test__/fixtures.test.ts @@ -1,10 +1,12 @@ +import isPlainObject from "@fern-ui/core-utils/isPlainObject"; import fs from "fs"; import path from "path"; -import { FernNavigation } from "../.."; -import { isPlainObject } from "../../utils"; -import { NodeCollector } from "../NodeCollector"; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; -import { collectPageIds } from "../utils/collectPageIds"; +import { FernNavigation } from ".."; +import * as ApiDefinition from "../api-definition"; +import { ApiDefinitionV1ToLatest } from "../api-definition/migrators/v1ToV2"; +import { NodeCollector } from "../navigation/NodeCollector"; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; +import { collectPageIds } from "../navigation/utils/collectPageIds"; import { readFixture } from "./readFixtures"; const fixturesDir = path.join(__dirname, "fixtures"); @@ -14,11 +16,19 @@ function testNavigationConfigConverter(fixtureName: string): void { const v1 = FernNavigation.V1.toRootNode(fixture); const latest = FernNavigationV1ToLatest.create().root(v1); + const v2Apis = Object.values(fixture.definition.apis).map((api) => + ApiDefinitionV1ToLatest.from(api, { + useJavaScriptAsTypeScript: false, + alwaysEnableJavaScriptFetch: false, + usesApplicationJsonInFormDataValue: false, + }).migrate(), + ); + // eslint-disable-next-line vitest/valid-title describe(fixtureName, () => { const collector = new NodeCollector(latest); - it("gets all urls from docs config", async () => { + it("gets all urls from docs config", () => { expect(JSON.stringify(sortObject(latest), undefined, 2)).toMatchFileSnapshot( `output/${fixtureName}/node.json`, ); @@ -58,6 +68,27 @@ function testNavigationConfigConverter(fixtureName: string): void { expect(JSON.stringify(sortObject(collector.getVersionNodes()), undefined, 2)).toMatchFileSnapshot( `output/${fixtureName}/versionNodes.json`, ); + + expect(JSON.stringify(v2Apis, undefined, 2)).toMatchFileSnapshot( + `output/${fixtureName}/apiDefinitions.json`, + ); + }); + + describe("transformer", () => { + it("should generate unique keys", async () => { + for (const api of Object.values(v2Apis)) { + const keys: string[] = []; + + await ApiDefinition.Transformer.keys((key) => keys.push(key)).apiDefinition(api); + + expect(JSON.stringify(keys, undefined, 2)).toMatchFileSnapshot( + `output/${fixtureName}/apiDefinitionKeys-${api.id}.json`, + ); + + // all keys must be unique + expect(Array.from(new Set(keys)).length).toBe(keys.length); + } + }); }); it("should have unique canonical urls for each page", () => { diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/assemblyai.json b/packages/fdr-sdk/src/__test__/fixtures/assemblyai.json similarity index 99% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/assemblyai.json rename to packages/fdr-sdk/src/__test__/fixtures/assemblyai.json index 2bcb1e76e1..d46857c5d9 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures/assemblyai.json +++ b/packages/fdr-sdk/src/__test__/fixtures/assemblyai.json @@ -15000,13 +15000,13 @@ } }, "files": { - "eaff1b77-0988-489d-b430-793cfad2bc54": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/ABCMonumentGrotesk-Regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240531%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240531T192111Z&X-Amz-Expires=604800&X-Amz-Signature=c1b697fe1027be563d0167c5d2fde64197c22dd4f1d77f0028f0cb617396a3f8&X-Amz-SignedHeaders=host&x-id=GetObject", - "36e34a20-ff6d-4cde-8b14-92d6ff2af084": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/ABCMonumentGrotesk-Medium.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240531%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240531T192111Z&X-Amz-Expires=604800&X-Amz-Signature=5f774938d6aab931be53cb1532d88454e2fe14ccc2c8f3ac2981b49ab53c73a0&X-Amz-SignedHeaders=host&x-id=GetObject", - "744e09e3-6bb2-4881-8e7b-c26ad4d8f752": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/ABCMonumentGrotesk-Bold.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240531%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240531T192111Z&X-Amz-Expires=604800&X-Amz-Signature=c127e2555cfa09e3388c8dedf269655e9c2e5055ee8adcdd3446c7b23e17faf9&X-Amz-SignedHeaders=host&x-id=GetObject", - "6c188f84-edb2-4fbd-93a7-d4a7374f5693": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/JetBrainsMono-Regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240531%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240531T192111Z&X-Amz-Expires=604800&X-Amz-Signature=f81ea5b5e7150031fb01e149b59490fab593a26437cbf4876eac918be067784a&X-Amz-SignedHeaders=host&x-id=GetObject", - "f981c76f-4e4b-4ef7-a199-4e6fc53b8c5f": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/JetBrainsMono-Medium.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240531%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240531T192111Z&X-Amz-Expires=604800&X-Amz-Signature=37ce283e32014ed9af561a8fd1e5654931680f7f22742a75d9a134ba70851981&X-Amz-SignedHeaders=host&x-id=GetObject", - "5351f437-2e66-4272-9488-e376c093233d": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/AssemblyAI_White.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240531%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240531T192111Z&X-Amz-Expires=604800&X-Amz-Signature=ff41d6c6343c6772357ccb7b16da3b04bccdd1b8e5384f9c7d22bc8e8dd030a9&X-Amz-SignedHeaders=host&x-id=GetObject", - "e5c8b272-6062-415e-b5ec-8e446c129fc2": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/favicon.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240531%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240531T192111Z&X-Amz-Expires=604800&X-Amz-Signature=cffbdb9a08ff637e5b37fe2f402dbdeec9d764417ee49d3638265e3f19211c7d&X-Amz-SignedHeaders=host&x-id=GetObject" + "eaff1b77-0988-489d-b430-793cfad2bc54": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/ABCMonumentGrotesk-Regular.woff2", + "36e34a20-ff6d-4cde-8b14-92d6ff2af084": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/ABCMonumentGrotesk-Medium.woff2", + "744e09e3-6bb2-4881-8e7b-c26ad4d8f752": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/ABCMonumentGrotesk-Bold.woff2", + "6c188f84-edb2-4fbd-93a7-d4a7374f5693": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/JetBrainsMono-Regular.woff2", + "f981c76f-4e4b-4ef7-a199-4e6fc53b8c5f": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/JetBrainsMono-Medium.woff2", + "5351f437-2e66-4272-9488-e376c093233d": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/AssemblyAI_White.svg", + "e5c8b272-6062-415e-b5ec-8e446c129fc2": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/assemblyai.docs.buildwithfern.com/docs/2024-05-31T19%3A21%3A05.796Z/assets/favicon.png" }, "filesV2": { "eaff1b77-0988-489d-b430-793cfad2bc54": { diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/astronomer.json b/packages/fdr-sdk/src/__test__/fixtures/astronomer.json similarity index 99% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/astronomer.json rename to packages/fdr-sdk/src/__test__/fixtures/astronomer.json index c8ae816ebf..850cfb1e08 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures/astronomer.json +++ b/packages/fdr-sdk/src/__test__/fixtures/astronomer.json @@ -30742,9 +30742,9 @@ } }, "files": { - "015057e2-bb14-4cd7-97dd-b2cca2a0b221": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/astronomer.docs.buildwithfern.com/docs/api/2024-05-24T18%3A11%3A19.885Z/docs/assets/logo-dark.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240524T181126Z&X-Amz-Expires=604800&X-Amz-Signature=6f1c9d734aadc87fe7616663d5488b60eeca4b38b7fc16220f49b7ab347ebc6a&X-Amz-SignedHeaders=host&x-id=GetObject", - "49419424-29d4-4e84-983a-1d6d69cf072d": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/astronomer.docs.buildwithfern.com/docs/api/2024-05-24T18%3A11%3A19.885Z/docs/assets/logo-light.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240524T181126Z&X-Amz-Expires=604800&X-Amz-Signature=cc7645af242e4c0405dfa08807eabacffbd170bd8fb95eb89c441dd394184f32&X-Amz-SignedHeaders=host&x-id=GetObject", - "06193aca-2385-478c-8973-6c20d3994186": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/astronomer.docs.buildwithfern.com/docs/api/2024-05-24T18%3A11%3A19.885Z/docs/assets/favicon.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240524T181126Z&X-Amz-Expires=604800&X-Amz-Signature=6ac0c469761e7e63a44bd1220bd4d3f9866d53fd7df2e18c5c3dc9d18c6c24a7&X-Amz-SignedHeaders=host&x-id=GetObject" + "015057e2-bb14-4cd7-97dd-b2cca2a0b221": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/astronomer.docs.buildwithfern.com/docs/api/2024-05-24T18%3A11%3A19.885Z/docs/assets/logo-dark.svg", + "49419424-29d4-4e84-983a-1d6d69cf072d": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/astronomer.docs.buildwithfern.com/docs/api/2024-05-24T18%3A11%3A19.885Z/docs/assets/logo-light.svg", + "06193aca-2385-478c-8973-6c20d3994186": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/astronomer.docs.buildwithfern.com/docs/api/2024-05-24T18%3A11%3A19.885Z/docs/assets/favicon.svg" }, "filesV2": { "015057e2-bb14-4cd7-97dd-b2cca2a0b221": { diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/humanloop.json b/packages/fdr-sdk/src/__test__/fixtures/humanloop.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/humanloop.json rename to packages/fdr-sdk/src/__test__/fixtures/humanloop.json diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/hume.json b/packages/fdr-sdk/src/__test__/fixtures/hume.json similarity index 99% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/hume.json rename to packages/fdr-sdk/src/__test__/fixtures/hume.json index af97be0047..3c0f858e9f 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures/hume.json +++ b/packages/fdr-sdk/src/__test__/fixtures/hume.json @@ -25188,14 +25188,14 @@ } }, "files": { - "4a995ab2-bc80-4cc7-bd16-5b477e98a000": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/Fellix-Regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=c73a99891dc8c5effc9bd1885d68f1e4a663e28e2b86eb1a40ee432749856462&X-Amz-SignedHeaders=host&x-id=GetObject", - "724861df-6bdb-40c2-a082-7deaf355a5a8": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/Fellix-Medium.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=7d7f832468092efe7b1d13382fdfe0476899e8803fe672f5df9b42bcff9f1a9d&X-Amz-SignedHeaders=host&x-id=GetObject", - "67fe2f9d-13c2-485e-bbca-df9c46760bb7": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/Fellix-SemiBold.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=b3cdcd6b838b80a7cb28589cdc31886abe02ac61d047436253df38972067f194&X-Amz-SignedHeaders=host&x-id=GetObject", - "3f8d3a6d-09f6-4799-a069-54a2adf6b036": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/FraktionMono-Regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=ef0baa3814c2e233524c70dd1ed33f87166ca3e9c1ad8c219cff20d9223e4052&X-Amz-SignedHeaders=host&x-id=GetObject", - "6d34714f-0bf0-47c5-bc07-acf1e117064f": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/FraktionMono-Bold.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=9624cad12b049c50bd24ef8a2b23dc834d7c9034aea3c30a509f9456b5c05359&X-Amz-SignedHeaders=host&x-id=GetObject", - "d76e7b76-7299-4a83-8095-49b065dff86e": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/assets/logo-dark-mode.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=6231acdd2e025e9bf50771b6640df7f98ca5f8ec6a528c4760e3f34567e5db0c&X-Amz-SignedHeaders=host&x-id=GetObject", - "cda9fa3b-f513-4ad3-89b9-1bc95a761c70": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/assets/logo-light-mode.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=2b34dbbf84c437db015ccba4b167962c1cb65a7b2545628ce46dddcbe25253d4&X-Amz-SignedHeaders=host&x-id=GetObject", - "e34bc051-3181-4e76-b86f-7094e10f229a": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/assets/favicon.ico?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205424Z&X-Amz-Expires=604800&X-Amz-Signature=98ca7c1770898985e0ae2fa9cd322959a67a66381908875bc5f50e8697437243&X-Amz-SignedHeaders=host&x-id=GetObject" + "4a995ab2-bc80-4cc7-bd16-5b477e98a000": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/Fellix-Regular.woff2", + "724861df-6bdb-40c2-a082-7deaf355a5a8": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/Fellix-Medium.woff2", + "67fe2f9d-13c2-485e-bbca-df9c46760bb7": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/Fellix-SemiBold.woff2", + "3f8d3a6d-09f6-4799-a069-54a2adf6b036": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/FraktionMono-Regular.woff2", + "6d34714f-0bf0-47c5-bc07-acf1e117064f": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/fonts/FraktionMono-Bold.woff2", + "d76e7b76-7299-4a83-8095-49b065dff86e": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/assets/logo-dark-mode.png", + "cda9fa3b-f513-4ad3-89b9-1bc95a761c70": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/assets/logo-light-mode.png", + "e34bc051-3181-4e76-b86f-7094e10f229a": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/hume.docs.buildwithfern.com/2024-05-30T20%3A54%3A14.167Z/docs/assets/favicon.ico" }, "filesV2": { "4a995ab2-bc80-4cc7-bd16-5b477e98a000": { diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/no-version-no-tabs.json b/packages/fdr-sdk/src/__test__/fixtures/no-version-no-tabs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/no-version-no-tabs.json rename to packages/fdr-sdk/src/__test__/fixtures/no-version-no-tabs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/no-version-yes-tabs.json b/packages/fdr-sdk/src/__test__/fixtures/no-version-yes-tabs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/no-version-yes-tabs.json rename to packages/fdr-sdk/src/__test__/fixtures/no-version-yes-tabs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/octoai.json b/packages/fdr-sdk/src/__test__/fixtures/octoai.json similarity index 99% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/octoai.json rename to packages/fdr-sdk/src/__test__/fixtures/octoai.json index 022456042b..a92339c6ca 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures/octoai.json +++ b/packages/fdr-sdk/src/__test__/fixtures/octoai.json @@ -31140,23 +31140,23 @@ } }, "files": { - "28634fb5-e7bf-48e5-8950-ec75598f9a33": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/fonts/Faktum-Regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=4685f00ae0a0bcc39bbf12974287fe7124b222e0fc6db0f10467d51d544d4443&X-Amz-SignedHeaders=host&x-id=GetObject", - "67ace420-e431-4047-9031-39b01a0815f9": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/fonts/Faktum-Medium.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=ebfc6325f30ad7dc24c1b0de1c3e476ed9ad4c7cdac251cbca33a55172489267&X-Amz-SignedHeaders=host&x-id=GetObject", - "d2caeedb-042a-459b-a10e-9d090167ea4f": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/fonts/Faktum-SemiBold.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=700a57dc1bb549ec7b48d9c6c7e49454e7e61d3f44c3d8af7fac012ca982b61d&X-Amz-SignedHeaders=host&x-id=GetObject", - "25b9c627-4c15-4398-be27-8040160c2b74": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/logo/octoai-logo-dark.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=8f09f78c06c0d78c971aa4bbd25cfd87df826de5bc45a82b336015565b36a5d6&X-Amz-SignedHeaders=host&x-id=GetObject", - "3f0a7ef8-4d3c-4ee5-b046-cbc13cef6274": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/logo/octoai-logo-light.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=c4efecf921f823fe8a83ed8f45a11c661393926a8ddbcb319b5f384e87288b14&X-Amz-SignedHeaders=host&x-id=GetObject", - "d2848057-bb27-44c5-9e9f-5e358a6a9c29": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/favicon.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=f65c596a049a321956efaf03ba768a6c57aa9971d300b47b69bed63d0dc5f01b&X-Amz-SignedHeaders=host&x-id=GetObject", - "a1db33e3-0540-4764-92e6-e56ce4eb32e0": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/gradient-bg-dark.webp?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=2ff29bcdb0b6c53cf4b57320c74f9a28fa966f3adc945ae88e175507879d9aab&X-Amz-SignedHeaders=host&x-id=GetObject", - "12c01624-1783-4e1e-9ffe-2034acd4154c": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/gradient-bg-light.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=b4703664d450f5e985ee3c1d2abadd983950bf235ab2880818be195143d0d9d4&X-Amz-SignedHeaders=host&x-id=GetObject", - "236355ae-c997-4c10-b18a-bce6f4c79fa0": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/quickstart-curl-example.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=643c963d316d23efe6845f0cf2a0870789e354771a372644f628c3210527d3a9&X-Amz-SignedHeaders=host&x-id=GetObject", - "401c961a-1481-4717-a837-10a0dca52fa7": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/langchain.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=4927ba1ca1fcc473912120969ac73b600ab7e00a9db533a89e3d3a868699af7a&X-Amz-SignedHeaders=host&x-id=GetObject", - "7556700f-ad9f-4b95-924f-73c87af7d36b": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/unstructured.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=4475a66ce697fffc25d9ae9d76d54b56bff823b48a95815aaf1c0f5433a8ab67&X-Amz-SignedHeaders=host&x-id=GetObject", - "f8d07fb4-b1e4-4adf-8678-8c3b4e1dc1b2": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/pinecone.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=7c165bf4b8e88d5030a641966e6a89e2fa5741f2d77ed8bc975f477ef911af14&X-Amz-SignedHeaders=host&x-id=GetObject", - "17ed68ed-3f3b-4863-bc65-a716d640f557": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/openrouter.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=8cb401fd85524f702bced761832e512d8983141ca4711c8b93d6f274e4487378&X-Amz-SignedHeaders=host&x-id=GetObject", - "e7159389-f6f1-4bfa-8fc1-d2cc7256b0da": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/llamaindex.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=b0f527faacf18a79fa20a86213abd3121e809c223a868c3d45157a6fa1470752&X-Amz-SignedHeaders=host&x-id=GetObject", - "5679d19e-04a2-4ed2-ba89-1fb38e521adf": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/icons/heart.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=1755ebb670fb12f3d24cb74436a1885ab15145d68d7230356855922f00e73a1b&X-Amz-SignedHeaders=host&x-id=GetObject", - "a090b4d6-cbde-4b2b-ba94-e021f246f037": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/icons/plus.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=d43619d6d0fa83f9fc0a69914ca9753aa6ddd5ed2f5febf0c17b53f044935b40&X-Amz-SignedHeaders=host&x-id=GetObject", - "ed68d643-84cd-40c7-8745-0557b4e9c857": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/icons/check.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240530%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240530T205205Z&X-Amz-Expires=604800&X-Amz-Signature=7336d794c7a858131d59c7b138a6bf22dc87e99b659601a8d71638dfffdd833a&X-Amz-SignedHeaders=host&x-id=GetObject" + "28634fb5-e7bf-48e5-8950-ec75598f9a33": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/fonts/Faktum-Regular.woff2", + "67ace420-e431-4047-9031-39b01a0815f9": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/fonts/Faktum-Medium.woff2", + "d2caeedb-042a-459b-a10e-9d090167ea4f": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/fonts/Faktum-SemiBold.woff2", + "25b9c627-4c15-4398-be27-8040160c2b74": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/logo/octoai-logo-dark.svg", + "3f0a7ef8-4d3c-4ee5-b046-cbc13cef6274": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/logo/octoai-logo-light.svg", + "d2848057-bb27-44c5-9e9f-5e358a6a9c29": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/favicon.png", + "a1db33e3-0540-4764-92e6-e56ce4eb32e0": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/gradient-bg-dark.webp", + "12c01624-1783-4e1e-9ffe-2034acd4154c": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/gradient-bg-light.svg", + "236355ae-c997-4c10-b18a-bce6f4c79fa0": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/images/quickstart-curl-example.png", + "401c961a-1481-4717-a837-10a0dca52fa7": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/langchain.svg", + "7556700f-ad9f-4b95-924f-73c87af7d36b": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/unstructured.svg", + "f8d07fb4-b1e4-4adf-8678-8c3b4e1dc1b2": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/pinecone.svg", + "17ed68ed-3f3b-4863-bc65-a716d640f557": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/openrouter.svg", + "e7159389-f6f1-4bfa-8fc1-d2cc7256b0da": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/logos/llamaindex.svg", + "5679d19e-04a2-4ed2-ba89-1fb38e521adf": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/icons/heart.svg", + "a090b4d6-cbde-4b2b-ba94-e021f246f037": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/icons/plus.svg", + "ed68d643-84cd-40c7-8745-0557b4e9c857": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/octoai.docs.buildwithfern.com/docs/2024-05-30T20%3A51%3A57.535Z/docs/assets/icons/check.svg" }, "filesV2": { "28634fb5-e7bf-48e5-8950-ec75598f9a33": { diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/polytomic.json b/packages/fdr-sdk/src/__test__/fixtures/polytomic.json similarity index 99% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/polytomic.json rename to packages/fdr-sdk/src/__test__/fixtures/polytomic.json index 3b3b270846..e0abb8f5b3 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures/polytomic.json +++ b/packages/fdr-sdk/src/__test__/fixtures/polytomic.json @@ -109601,8 +109601,8 @@ } }, "files": { - "f7d48879-3bc9-40ec-9177-8593eb5b1a03": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/polytomic.docs.buildwithfern.com/2024-06-03T19%3A13%3A59.961Z/docs/assets/polytomic_logo_dark.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240603%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240603T191413Z&X-Amz-Expires=604800&X-Amz-Signature=fffb8309f0ff8ad83946c940640fe8d4595d3aa4bc55294079049d1bd9bddf72&X-Amz-SignedHeaders=host&x-id=GetObject", - "c1c7828c-b608-423d-b030-d9ab35491258": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/polytomic.docs.buildwithfern.com/2024-06-03T19%3A13%3A59.961Z/docs/assets/polytomic_favicon.ico?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240603%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240603T191413Z&X-Amz-Expires=604800&X-Amz-Signature=8bdfd46b6a666e986cdf4f7188060de93742b3fa8c7e459e9737010d4b5a47fc&X-Amz-SignedHeaders=host&x-id=GetObject" + "f7d48879-3bc9-40ec-9177-8593eb5b1a03": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/polytomic.docs.buildwithfern.com/2024-06-03T19%3A13%3A59.961Z/docs/assets/polytomic_logo_dark.png", + "c1c7828c-b608-423d-b030-d9ab35491258": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/polytomic.docs.buildwithfern.com/2024-06-03T19%3A13%3A59.961Z/docs/assets/polytomic_favicon.ico" }, "filesV2": { "f7d48879-3bc9-40ec-9177-8593eb5b1a03": { @@ -110824,4 +110824,3 @@ }, "lightModeEnabled": false } - diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/primer.json b/packages/fdr-sdk/src/__test__/fixtures/primer.json similarity index 99% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/primer.json rename to packages/fdr-sdk/src/__test__/fixtures/primer.json index bcbc7151e4..f38ca7d734 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures/primer.json +++ b/packages/fdr-sdk/src/__test__/fixtures/primer.json @@ -71845,32 +71845,32 @@ } }, "files": { - "08d92b5c-160d-402d-93df-2bc45937d452": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/logo-light.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=0be5d8b27bf4822517d0347937525f7633caaf6873370ed5a149fca1c773272e&X-Amz-SignedHeaders=host&x-id=GetObject", - "975a6979-0084-46bd-ad9a-7afba3eefd45": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/favicon.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=786944c68d29de1c6b3d55590a5d64210fc5895226a70d4e4fdff8383c2fbaa7&X-Amz-SignedHeaders=host&x-id=GetObject", - "0d6ed85d-c804-4437-aadf-2800c423b60d": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Bold.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=29b4c017219147afea2f962b07ba53c50c5acb83d2b756e0c4e6784767872a50&X-Amz-SignedHeaders=host&x-id=GetObject", - "ab8dc118-977b-4a55-aec7-25f73cfa0722": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=861de48a53a1f3542836ecabab094a7795e44de77771cf519af457281ce10845&X-Amz-SignedHeaders=host&x-id=GetObject", - "8eea746f-0f4a-484e-b578-39e147861c3e": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Roboto-Mono-regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=98e58420083936ed108ed9c22e128271ecd5bd6d007d33bf1b8f6fad34d2082a&X-Amz-SignedHeaders=host&x-id=GetObject" + "08d92b5c-160d-402d-93df-2bc45937d452": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/logo-light.png", + "975a6979-0084-46bd-ad9a-7afba3eefd45": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/favicon.png", + "0d6ed85d-c804-4437-aadf-2800c423b60d": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Bold.woff2", + "ab8dc118-977b-4a55-aec7-25f73cfa0722": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Regular.woff2", + "8eea746f-0f4a-484e-b578-39e147861c3e": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Roboto-Mono-regular.woff2" }, "filesV2": { "08d92b5c-160d-402d-93df-2bc45937d452": { "type": "url", - "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/logo-light.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=0be5d8b27bf4822517d0347937525f7633caaf6873370ed5a149fca1c773272e&X-Amz-SignedHeaders=host&x-id=GetObject" + "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/logo-light.png" }, "975a6979-0084-46bd-ad9a-7afba3eefd45": { "type": "url", - "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/favicon.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=786944c68d29de1c6b3d55590a5d64210fc5895226a70d4e4fdff8383c2fbaa7&X-Amz-SignedHeaders=host&x-id=GetObject" + "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/assets/favicon.png" }, "0d6ed85d-c804-4437-aadf-2800c423b60d": { "type": "url", - "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Bold.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=29b4c017219147afea2f962b07ba53c50c5acb83d2b756e0c4e6784767872a50&X-Amz-SignedHeaders=host&x-id=GetObject" + "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Bold.woff2" }, "ab8dc118-977b-4a55-aec7-25f73cfa0722": { "type": "url", - "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=861de48a53a1f3542836ecabab094a7795e44de77771cf519af457281ce10845&X-Amz-SignedHeaders=host&x-id=GetObject" + "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Inter-Regular.woff2" }, "8eea746f-0f4a-484e-b578-39e147861c3e": { "type": "url", - "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Roboto-Mono-regular.woff2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T222754Z&X-Amz-Expires=604800&X-Amz-Signature=98e58420083936ed108ed9c22e128271ecd5bd6d007d33bf1b8f6fad34d2082a&X-Amz-SignedHeaders=host&x-id=GetObject" + "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/primer.docs.buildwithfern.com/docs/api/2024-03-19T17%3A37%3A56.004Z/fonts/Roboto-Mono-regular.woff2" } }, "pages": { diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/uploadcare.json b/packages/fdr-sdk/src/__test__/fixtures/uploadcare.json similarity index 99% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/uploadcare.json rename to packages/fdr-sdk/src/__test__/fixtures/uploadcare.json index eb908e9800..343bbc7331 100644 --- a/packages/fdr-sdk/src/navigation/__test__/fixtures/uploadcare.json +++ b/packages/fdr-sdk/src/__test__/fixtures/uploadcare.json @@ -20413,19 +20413,19 @@ } }, "files": { - "5529d56f-3bd2-44b6-855e-eec308770b85": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/logo.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T153322Z&X-Amz-Expires=604800&X-Amz-Signature=c1292039da641b4195a9f2d0e6322a3935304e440fa814905aab6b5844bb707e&X-Amz-SignedHeaders=host&x-id=GetObject", - "419b3076-7e59-4e7b-831c-096df91b4e07": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/favicon.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T153322Z&X-Amz-Expires=604800&X-Amz-Signature=c01f3c13daf3089e67dd0805cfa80db12291dff010fd28d6d8b24c9dd2074249&X-Amz-SignedHeaders=host&x-id=GetObject" + "5529d56f-3bd2-44b6-855e-eec308770b85": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/logo.svg", + "419b3076-7e59-4e7b-831c-096df91b4e07": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/favicon.png" }, "filesV2": { "5529d56f-3bd2-44b6-855e-eec308770b85": { "type": "image", - "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/logo.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T153322Z&X-Amz-Expires=604800&X-Amz-Signature=c1292039da641b4195a9f2d0e6322a3935304e440fa814905aab6b5844bb707e&X-Amz-SignedHeaders=host&x-id=GetObject", + "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/logo.svg", "width": 314, "height": 59 }, "419b3076-7e59-4e7b-831c-096df91b4e07": { "type": "image", - "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/favicon.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNE6LAYO7B%2F20240323%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240323T153322Z&X-Amz-Expires=604800&X-Amz-Signature=c01f3c13daf3089e67dd0805cfa80db12291dff010fd28d6d8b24c9dd2074249&X-Amz-SignedHeaders=host&x-id=GetObject", + "url": "https://fdr-prod-docs-files.s3.us-east-1.amazonaws.com/uploadcare-preview-79798ef5-07dc-4ff0-928d-24b4c93ccd4d.docs.buildwithfern.com/2024-03-23T15%3A33%3A18.120Z/assets/favicon.png", "width": 32, "height": 32 } diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/yes-version-no-tabs.json b/packages/fdr-sdk/src/__test__/fixtures/yes-version-no-tabs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/yes-version-no-tabs.json rename to packages/fdr-sdk/src/__test__/fixtures/yes-version-no-tabs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/fixtures/yes-version-yes-tabs.json b/packages/fdr-sdk/src/__test__/fixtures/yes-version-yes-tabs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/fixtures/yes-version-yes-tabs.json rename to packages/fdr-sdk/src/__test__/fixtures/yes-version-yes-tabs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/hume.test.ts b/packages/fdr-sdk/src/__test__/hume.test.ts similarity index 86% rename from packages/fdr-sdk/src/navigation/__test__/hume.test.ts rename to packages/fdr-sdk/src/__test__/hume.test.ts index 119d6e951c..305f4dae9f 100644 --- a/packages/fdr-sdk/src/navigation/__test__/hume.test.ts +++ b/packages/fdr-sdk/src/__test__/hume.test.ts @@ -1,6 +1,6 @@ import { describe } from "vitest"; -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/navigation/__test__/no-version-no-tabs.test.ts b/packages/fdr-sdk/src/__test__/no-version-no-tabs.test.ts similarity index 86% rename from packages/fdr-sdk/src/navigation/__test__/no-version-no-tabs.test.ts rename to packages/fdr-sdk/src/__test__/no-version-no-tabs.test.ts index 01bc34f74c..890ea2cb39 100644 --- a/packages/fdr-sdk/src/navigation/__test__/no-version-no-tabs.test.ts +++ b/packages/fdr-sdk/src/__test__/no-version-no-tabs.test.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/navigation/__test__/no-version-yes-tabs.test.ts b/packages/fdr-sdk/src/__test__/no-version-yes-tabs.test.ts similarity index 87% rename from packages/fdr-sdk/src/navigation/__test__/no-version-yes-tabs.test.ts rename to packages/fdr-sdk/src/__test__/no-version-yes-tabs.test.ts index 3493b5faa1..9f67319472 100644 --- a/packages/fdr-sdk/src/navigation/__test__/no-version-yes-tabs.test.ts +++ b/packages/fdr-sdk/src/__test__/no-version-yes-tabs.test.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/navigation/__test__/octoai.test.ts b/packages/fdr-sdk/src/__test__/octoai.test.ts similarity index 88% rename from packages/fdr-sdk/src/navigation/__test__/octoai.test.ts rename to packages/fdr-sdk/src/__test__/octoai.test.ts index fa1976893a..814607aa20 100644 --- a/packages/fdr-sdk/src/navigation/__test__/octoai.test.ts +++ b/packages/fdr-sdk/src/__test__/octoai.test.ts @@ -1,6 +1,6 @@ import { describe } from "vitest"; -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitionKeys-72c824a6-ca97-4592-a585-266e983022de.json b/packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitionKeys-72c824a6-ca97-4592-a585-266e983022de.json new file mode 100644 index 0000000000..9152a3987b --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitionKeys-72c824a6-ca97-4592-a585-266e983022de.json @@ -0,0 +1,1280 @@ +[ + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/query/limit", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/query/status", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/query/created_on", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/query/before_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/query/after_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/query/throttled_only", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/request/object/property/audio_url", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/path/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/path/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/path/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/path/subtitle_format", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/query/chars_per_caption", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/path/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/path/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/path/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/query/words", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/path/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/request/object/property/prompt", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/request/object/property/answer_format", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/request/object/property/questions", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/request/object/property/answer_format", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/path/request_id", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/request/object/property/expires_in", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/0/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/1/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/2/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/3/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/4/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/5/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/6/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/7/snippet/curl/0", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/query/sample_rate", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/query/word_boost", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/query/encoding", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/query/token", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/query/disable_partial_transcripts", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/query/enable_extra_session_information", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/requestHeader/Authentication", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/example/0", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_files:UploadedFile/shape/object/property/upload_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyNotification/shape/object/property/transcript_id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyNotification/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactedAudioResponse/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactedAudioResponse/shape/object/property/redacted_audio_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubtitleFormat/shape/enum/value/srt", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubtitleFormat/shape/enum/value/vtt", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchResponse/shape/object/property/id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchResponse/shape/object/property/total_count", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchResponse/shape/object/property/matches", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchMatch/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchMatch/shape/object/property/count", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchMatch/shape/object/property/timestamps", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchMatch/shape/object/property/indexes", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Timestamp/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Timestamp/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/language_code", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/punctuate", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/format_text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/dual_channel", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/speech_model", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/webhook_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/webhook_auth_header_name", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/webhook_auth_header_value", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/auto_highlights", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/audio_start_from", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/audio_end_at", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/word_boost", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/boost_param", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/filter_profanity", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/redact_pii", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/redact_pii_audio", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/redact_pii_audio_quality", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/redact_pii_policies", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/redact_pii_sub", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/speaker_labels", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/speakers_expected", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/content_safety", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/content_safety_confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/iab_categories", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/language_detection", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/custom_spelling", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/disfluencies", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/sentiment_analysis", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/auto_chapters", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/entity_detection", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/speech_threshold", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/summarization", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/summary_model", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/summary_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/custom_topics", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object/property/topics", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryModel/shape/enum/value/informative", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryModel/shape/enum/value/conversational", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryModel/shape/enum/value/catchy", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryType/shape/enum/value/bullets", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryType/shape/enum/value/bullets_verbose", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryType/shape/enum/value/gist", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryType/shape/enum/value/headline", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryType/shape/enum/value/paragraph", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptBoostParam/shape/enum/value/low", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptBoostParam/shape/enum/value/default", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptBoostParam/shape/enum/value/high", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptCustomSpelling/shape/object/property/from", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptCustomSpelling/shape/object/property/to", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape/object/property/words", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape/object/property/speaker", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubstitutionPolicy/shape/enum/value/entity_name", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubstitutionPolicy/shape/enum/value/hash", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactPiiAudioQuality/shape/enum/value/mp3", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactPiiAudioQuality/shape/enum/value/wav", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/account_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/banking_information", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/blood_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/credit_card_cvv", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/credit_card_expiration", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/credit_card_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/date", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/date_interval", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/date_of_birth", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/drivers_license", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/drug", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/duration", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/email_address", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/event", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/filename", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/gender_sexuality", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/healthcare_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/injury", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/ip_address", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/language", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/location", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/marital_status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/medical_condition", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/medical_process", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/money_amount", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/nationality", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/number_sequence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/occupation", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/organization", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/passport_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/password", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/person_age", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/person_name", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/phone_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/physical_attribute", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/political_affiliation", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/religion", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/statistics", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/time", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/us_social_security_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/username", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/vehicle_id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape/enum/value/zodiac_sign", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SpeechModel/shape/enum/value/best", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SpeechModel/shape/enum/value/nano", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SpeechModel/shape/enum/value/conformer-2", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/en", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/en_au", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/en_uk", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/en_us", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/es", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/fr", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/de", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/it", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/pt", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/nl", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/af", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sq", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/am", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ar", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/hy", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/as", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/az", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ba", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/eu", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/be", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/bn", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/bs", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/br", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/bg", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/my", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ca", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/zh", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/hr", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/cs", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/da", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/et", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/fo", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/fi", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/gl", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ka", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/el", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/gu", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ht", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ha", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/haw", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/he", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/hi", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/hu", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/is", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ja", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/jw", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/kn", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/kk", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/km", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ko", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/lo", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/la", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/lv", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ln", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/lt", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/lb", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/mk", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/mg", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ms", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ml", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/mt", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/mi", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/mr", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/mn", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ne", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/no", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/nn", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/oc", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/pa", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ps", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/fa", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/pl", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ro", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ru", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sa", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sr", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sn", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sd", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/si", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sk", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sl", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/so", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/su", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sw", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/sv", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/tl", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/tg", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ta", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/tt", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/te", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/th", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/bo", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/tr", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/tk", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/uk", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/ur", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/uz", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/vi", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/cy", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/yi", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape/enum/value/yo", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptStatus/shape/enum/value/queued", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptStatus/shape/enum/value/processing", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptStatus/shape/enum/value/completed", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptStatus/shape/enum/value/error", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyStatus/shape/enum/value/completed", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyStatus/shape/enum/value/error", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/language_model", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/acoustic_model", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/language_code", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/audio_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/words", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/utterances", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/audio_duration", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/punctuate", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/format_text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/dual_channel", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/speech_model", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/webhook_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/webhook_status_code", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/webhook_auth", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/webhook_auth_header_name", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/speed_boost", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/auto_highlights", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/auto_highlights_result", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/audio_start_from", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/audio_end_at", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/word_boost", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/boost_param", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/filter_profanity", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/redact_pii", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/redact_pii_audio", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/redact_pii_audio_quality", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/redact_pii_policies", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/redact_pii_sub", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/speaker_labels", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/speakers_expected", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/content_safety", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/content_safety_labels", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/iab_categories", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/iab_categories_result", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/language_detection", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/custom_spelling", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/auto_chapters", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/chapters", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/summarization", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/summary_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/summary_model", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/summary", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/custom_topics", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/topics", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/disfluencies", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/sentiment_analysis", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/sentiment_analysis_results", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/entity_detection", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/entities", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/speech_threshold", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/throttled", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object/property/error", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionModelResult/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionModelResult/shape/object/property/results", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionModelResult/shape/object/property/summary", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelsResult/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelsResult/shape/object/property/results", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelsResult/shape/object/property/summary", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelsResult/shape/object/property/severity_score_summary", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter/shape/object/property/gist", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter/shape/object/property/headline", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter/shape/object/property/summary", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Entity/shape/object/property/entity_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Entity/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Entity/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Entity/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/account_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/banking_information", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/blood_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/credit_card_cvv", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/credit_card_expiration", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/credit_card_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/date", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/date_interval", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/date_of_birth", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/drivers_license", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/drug", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/duration", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/email_address", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/event", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/filename", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/gender_sexuality", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/healthcare_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/injury", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/ip_address", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/language", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/location", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/marital_status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/medical_condition", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/medical_process", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/money_amount", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/nationality", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/number_sequence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/occupation", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/organization", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/passport_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/password", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/person_age", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/person_name", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/phone_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/physical_attribute", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/political_affiliation", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/religion", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/statistics", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/time", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/us_social_security_number", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/username", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/vehicle_id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape/enum/value/zodiac_sign", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape/object/property/sentiment", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape/object/property/speaker", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Sentiment/shape/enum/value/POSITIVE", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Sentiment/shape/enum/value/NEUTRAL", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Sentiment/shape/enum/value/NEGATIVE", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResultLabelsItem/shape/object/property/relevance", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResultLabelsItem/shape/object/property/label", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResult/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResult/shape/object/property/labels", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResult/shape/object/property/timestamp", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabel/shape/object/property/label", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabel/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabel/shape/object/property/severity", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult/shape/object/property/labels", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult/shape/object/property/sentences_idx_start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult/shape/object/property/sentences_idx_end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult/shape/object/property/timestamp", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SeverityScoreSummary/shape/object/property/low", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SeverityScoreSummary/shape/object/property/medium", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SeverityScoreSummary/shape/object/property/high", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightsResult/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightsResult/shape/object/property/results", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightResult/shape/object/property/count", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightResult/shape/object/property/rank", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightResult/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightResult/shape/object/property/timestamps", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord/shape/object/property/speaker", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape/object/property/words", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape/object/property/speaker", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentencesResponse/shape/object/property/id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentencesResponse/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentencesResponse/shape/object/property/audio_duration", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentencesResponse/shape/object/property/sentences", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape/object/property/words", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape/object/property/speaker", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ParagraphsResponse/shape/object/property/id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ParagraphsResponse/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ParagraphsResponse/shape/object/property/audio_duration", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ParagraphsResponse/shape/object/property/paragraphs", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails/shape/object/property/limit", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails/shape/object/property/result_count", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails/shape/object/property/current_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails/shape/object/property/prev_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails/shape/object/property/next_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object/property/id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object/property/resource_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object/property/created", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object/property/completed", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object/property/audio_url", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object/property/error", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptList/shape/object/property/page_details", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptList/shape/object/property/transcripts", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AudioIntelligenceModelStatus/shape/enum/value/success", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AudioIntelligenceModelStatus/shape/enum/value/unavailable", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseMessage/shape/object/property/message_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage/shape/undiscriminatedUnion/variant/0", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage/shape/undiscriminatedUnion/variant/1", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage/shape/undiscriminatedUnion/variant/2", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage/shape/undiscriminatedUnion/variant/3", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage/shape/undiscriminatedUnion/variant/4", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage/shape/undiscriminatedUnion/variant/5", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeError/shape/object/property/error", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:MessageType/shape/enum/value/SessionBegins", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:MessageType/shape/enum/value/PartialTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:MessageType/shape/enum/value/FinalTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:MessageType/shape/enum/value/SessionInformation", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:MessageType/shape/enum/value/SessionTerminated", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscriptType/shape/enum/value/PartialTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscriptType/shape/enum/value/FinalTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscript/shape/undiscriminatedUnion/variant/0", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscript/shape/undiscriminatedUnion/variant/1", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionBegins/shape/object/property/message_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionBegins/shape/object/property/session_id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionBegins/shape/object/property/expires_at", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionInformation/shape/object/property/message_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionInformation/shape/object/property/audio_duration_seconds", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionTerminated/shape/object/property/message_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape/object/property/audio_start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape/object/property/audio_end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape/object/property/words", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape/object/property/created", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:PartialTranscript/shape/object/property/message_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:FinalTranscript/shape/object/property/message_type", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:FinalTranscript/shape/object/property/punctuated", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:FinalTranscript/shape/object/property/text_formatted", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:Word/shape/object/property/start", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:Word/shape/object/property/end", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:Word/shape/object/property/confidence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:Word/shape/object/property/text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ForceEndUtterance/shape/object/property/force_end_utterance", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ConfigureEndUtteranceSilenceThreshold/shape/object/property/end_utterance_silence_threshold", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:TerminateSession/shape/object/property/terminate_session", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:AudioEncoding/shape/enum/value/pcm_s16le", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:AudioEncoding/shape/enum/value/pcm_mulaw", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTemporaryTokenResponse/shape/object/property/token", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:PurgeLemurRequestDataResponse/shape/object/property/request_id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:PurgeLemurRequestDataResponse/shape/object/property/request_id_to_purge", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:PurgeLemurRequestDataResponse/shape/object/property/deleted", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseResponse/shape/object/property/request_id", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurSummaryResponse/shape/object/property/response", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswerResponse/shape/object/property/response", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswer/shape/object/property/question", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswer/shape/object/property/answer", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurActionItemsResponse/shape/object/property/response", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurTaskResponse/shape/object/property/response", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParamsContext/shape/undiscriminatedUnion/variant/0", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParamsContext/shape/undiscriminatedUnion/variant/1", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape/object/property/transcript_ids", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape/object/property/input_text", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape/object/property/context", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape/object/property/final_model", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape/object/property/max_output_size", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape/object/property/temperature", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionContext/shape/undiscriminatedUnion/variant/0", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionContext/shape/undiscriminatedUnion/variant/1", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestion/shape/object/property/question", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestion/shape/object/property/context", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestion/shape/object/property/answer_format", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestion/shape/object/property/answer_options", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurModel/shape/enum/value/default", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurModel/shape/enum/value/basic", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurModel/shape/enum/value/assemblyai/mistral-7b", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurModel/shape/enum/value/anthropic/claude-2-1", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:Streaming/shape/enum/value/pcm_s16le", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:Streaming/shape/enum/value/pcm_mulaw", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage/shape/undiscriminatedUnion/variant/0", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage/shape/undiscriminatedUnion/variant/1", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage/shape/undiscriminatedUnion/variant/2", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage/shape/undiscriminatedUnion/variant/3", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage/shape/undiscriminatedUnion/variant/4", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage/shape/undiscriminatedUnion/variant/5", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:sendMessage/shape/undiscriminatedUnion/variant/0", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:sendMessage/shape/undiscriminatedUnion/variant/1", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:sendMessage/shape/undiscriminatedUnion/variant/2", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:sendMessage/shape/undiscriminatedUnion/variant/3", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_:Error/shape/object/property/error", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_:Error/shape/object/property/status", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/request", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/response", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/0/400/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/1/401/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/2/404/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/3/429/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/4/500/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/5/503/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/6/504/error/shape", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/message/server/subscribe/body", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/message/client/publish/body", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactedAudioStatus/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchTimestamp/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:AudioData/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/request/object", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/request/object", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/request/object", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/request/object", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/request/object", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/request/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_files:UploadedFile/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyNotification/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactedAudioResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchMatch/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Timestamp/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptCustomSpelling/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionModelResult/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelsResult/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Entity/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResultLabelsItem/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResult/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabel/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SeverityScoreSummary/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightsResult/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightResult/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentencesResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ParagraphsResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptList/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseMessage/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeError/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionBegins/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionInformation/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionTerminated/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:PartialTranscript/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:FinalTranscript/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:Word/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ForceEndUtterance/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ConfigureEndUtteranceSilenceThreshold/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:TerminateSession/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTemporaryTokenResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:PurgeLemurRequestDataResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurSummaryResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswerResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswer/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurActionItemsResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurTaskResponse/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestion/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_:Error/shape/object", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/message/server/subscribe", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming/message/client/publish", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactedAudioStatus", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubtitleFormat/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchTimestamp", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryModel/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryType/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptBoostParam/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubstitutionPolicy/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactPiiAudioQuality/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SpeechModel/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptStatus/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyStatus/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Sentiment/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AudioIntelligenceModelStatus/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:MessageType/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscriptType/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscript/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:AudioData", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:AudioEncoding/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParamsContext/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionContext/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurModel/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:Streaming/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:sendMessage/shape", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/0/400", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/1/401", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/2/404", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/3/429", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/4/500", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/5/503", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/error/6/504", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/0", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/1", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/2", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/3", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/4", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/5", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/6", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/example/7", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit/request", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task/request", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary/request", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer/request", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems/request", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken/request", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_files:UploadedFile/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyNotification/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactedAudioResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubtitleFormat", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchMatch/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Timestamp/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryModel", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SummaryType", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptBoostParam", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptCustomSpelling/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SubstitutionPolicy", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactPiiAudioQuality", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PiiPolicy", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SpeechModel", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptLanguageCode", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptStatus", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyStatus", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionModelResult/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelsResult/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Entity/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:EntityType", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Sentiment", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResultLabelsItem/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResult/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabel/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SeverityScoreSummary/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightsResult/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightResult/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentencesResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ParagraphsResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptList/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AudioIntelligenceModelStatus", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseMessage/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeMessage", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeError/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:MessageType", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscriptType", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionBegins/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionInformation/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionTerminated/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:PartialTranscript/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:FinalTranscript/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:Word/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ForceEndUtterance/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ConfigureEndUtteranceSilenceThreshold/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:TerminateSession/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:AudioEncoding", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTemporaryTokenResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:PurgeLemurRequestDataResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurSummaryResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswerResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswer/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurActionItemsResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurTaskResponse/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParamsContext", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionContext", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestion/shape", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurModel", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:Streaming", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:receiveMessage", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_streaming:sendMessage", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_:Error/shape", + "72c824a6-ca97-4592-a585-266e983022de/websocket/subpackage_streaming.streaming", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_files:UploadedFile", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptReadyNotification", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:RedactedAudioResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:WordSearchMatch", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Timestamp", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptOptionalParams", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptCustomSpelling", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptUtterance", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Transcript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionModelResult", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelsResult", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Chapter", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:Entity", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentimentAnalysisResult", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResultLabelsItem", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TopicDetectionResult", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabel", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ContentSafetyLabelResult", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SeverityScoreSummary", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightsResult", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:AutoHighlightResult", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptWord", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptSentence", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:SentencesResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptParagraph", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:ParagraphsResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:PageDetails", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptListItem", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_transcripts:TranscriptList", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseMessage", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeError", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionBegins", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionInformation", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:SessionTerminated", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeBaseTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:PartialTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:FinalTranscript", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:Word", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ForceEndUtterance", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:ConfigureEndUtteranceSilenceThreshold", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:TerminateSession", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_realtime:RealtimeTemporaryTokenResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:PurgeLemurRequestDataResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurSummaryResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswerResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestionAnswer", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurActionItemsResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurTaskResponse", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurBaseParams", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_lemur:LemurQuestion", + "72c824a6-ca97-4592-a585-266e983022de/type-definition/type_:Error", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_files.upload", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.list", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.submit", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.get", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.delete", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSubtitles", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getSentences", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getParagraphs", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.wordSearch", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_transcripts.getRedactedAudio", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.task", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.summary", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.questionAnswer", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.actionItems", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_lemur.purgeRequestData", + "72c824a6-ca97-4592-a585-266e983022de/endpoint/endpoint_realtime.createTemporaryToken" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitions.json new file mode 100644 index 0000000000..4a62b5a25c --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/assemblyai/apiDefinitions.json @@ -0,0 +1,12844 @@ +[ + { + "id": "72c824a6-ca97-4592-a585-266e983022de", + "endpoints": { + "endpoint_files.upload": { + "id": "endpoint_files.upload", + "namespace": [ + "subpackage_files" + ], + "description": "Upload a media file to AssemblyAI's servers.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v2/upload" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "request": { + "contentType": "application/octet-stream", + "body": { + "type": "bytes", + "isOptional": false, + "contentType": "application/octet-stream" + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_files:UploadedFile" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/upload", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": { + "upload_url": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + }, + { + "path": "/v2/upload", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + }, + { + "path": "/v2/upload", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + }, + { + "path": "/v2/upload", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + }, + { + "path": "/v2/upload", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + }, + { + "path": "/v2/upload", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + }, + { + "path": "/v2/upload", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + }, + { + "path": "/v2/upload", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "bytes", + "value": { + "type": "base64", + "value": "data:application/octet-stream;base64,SGVsbG8gd29ybGQh" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/upload \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.list": { + "id": "endpoint_transcripts.list", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Retrieve a list of transcripts you created.\nTranscripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v2/transcript" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "queryParameters": [ + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum amount of transcripts to retrieve" + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:TranscriptStatus" + } + }, + "description": "Filter by transcript status" + }, + { + "key": "created_on", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Only get transcripts created on this date" + }, + { + "key": "before_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Get transcripts that were created before this transcript ID" + }, + { + "key": "after_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Get transcripts that were created after this transcript ID" + }, + { + "key": "throttled_only", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Only get throttled transcripts, overrides the status filter" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:TranscriptList" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_details": { + "limit": 3, + "result_count": 3, + "current_url": "https://api.assemblyai.com/v2/transcript?limit=3", + "prev_url": "https://api.assemblyai.com/v2/transcript?limit=3&before_id=28a73d01-98db-41dd-9e98-2533ba0af117", + "next_url": "https://api.assemblyai.com/v2/transcript?limit=3&after_id=b33f4691-85b7-4f31-be12-a87cef1c1229" + }, + "transcripts": [ + { + "id": "b33f4691-85b7-4f31-be12-a87cef1c1229", + "resource_url": "https://api.assemblyai.com/v2/transcript/b33f4691-85b7-4f31-be12-a87cef1c1229", + "status": "completed", + "created": "2024-03-11T21:29:59Z", + "completed": "2024-03-11T21:30:07Z", + "audio_url": "http://deleted_by_user", + "error": "error" + }, + { + "id": "ce522f10-d204-42e8-a838-6b95098145cc", + "resource_url": "https://api.assemblyai.com/v2/transcript/ce522f10-d204-42e8-a838-6b95098145cc", + "status": "error", + "created": "2024-03-11T21:23:59Z", + "completed": "2024-01-15T09:30:00Z", + "audio_url": "https://storage.googleapis.com/client-docs-samples/nbc.mp3", + "error": "Download error, unable to download https://storage.googleapis.com/client-docs-samples/nbc.mp3. Please make sure the file exists and is accessible from the internet." + }, + { + "id": "28a73d01-98db-41dd-9e98-2533ba0af117", + "resource_url": "https://api.assemblyai.com/v2/transcript/28a73d01-98db-41dd-9e98-2533ba0af117", + "status": "completed", + "created": "2024-03-11T21:12:57Z", + "completed": "2024-03-11T21:13:03Z", + "audio_url": "https://storage.googleapis.com/aai-docs-samples/nbc.mp3", + "error": "error" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "limit": 0, + "status": "queued" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -d limit=0 \\\n -d status=queued", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "limit": 0, + "status": "queued" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -d limit=0 \\\n -d status=queued", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": { + "limit": 0, + "status": "queued" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -d limit=0 \\\n -d status=queued", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": { + "limit": 0, + "status": "queued" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -d limit=0 \\\n -d status=queued", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "limit": 0, + "status": "queued" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -d limit=0 \\\n -d status=queued", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": { + "limit": 0, + "status": "queued" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -d limit=0 \\\n -d status=queued", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": { + "limit": 0, + "status": "queued" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -d limit=0 \\\n -d status=queued", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.submit": { + "id": "endpoint_transcripts.submit", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Create a transcript from a media file that is accessible via a URL.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v2/transcript" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [ + "type_transcripts:TranscriptOptionalParams" + ], + "properties": [ + { + "key": "audio_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL of the audio or video file to transcribe." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:Transcript" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3", + "audio_end_at": 280, + "audio_start_from": 10, + "auto_chapters": true, + "auto_highlights": true, + "boost_param": "high", + "content_safety": true, + "custom_spelling": [ + { + "from": [ + "dicarlo" + ], + "to": "Decarlo" + } + ], + "custom_topics": true, + "disfluencies": false, + "dual_channel": true, + "entity_detection": true, + "filter_profanity": true, + "format_text": true, + "iab_categories": true, + "language_code": "en_us", + "language_detection": false, + "punctuate": true, + "redact_pii": true, + "redact_pii_audio": true, + "redact_pii_audio_quality": "mp3", + "redact_pii_policies": [ + "us_social_security_number", + "credit_card_number" + ], + "redact_pii_sub": "hash", + "sentiment_analysis": true, + "speaker_labels": true, + "speakers_expected": 2, + "speech_threshold": 0.5, + "summarization": true, + "summary_model": "informative", + "summary_type": "bullets", + "topics": [ + "topics" + ], + "webhook_auth_header_name": "webhook-secret", + "webhook_auth_header_value": "webhook-secret-value", + "webhook_url": "https://your-webhook-url/path", + "word_boost": [ + "aws", + "azure", + "google cloud" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "9ea68fd3-f953-42c1-9742-976c447fb463", + "language_model": "assemblyai_default", + "acoustic_model": "assemblyai_default", + "status": "completed", + "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3", + "webhook_auth": true, + "auto_highlights": true, + "redact_pii": true, + "summarization": true, + "language_code": "en_us", + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning. What is it about the conditions right now that have caused this round of wildfires to affect so many people so far away? Well, there's a couple of things. The season has been pretty dry already. And then the fact that we're getting hit in the US. Is because there's a couple of weather systems that are essentially channeling the smoke from those Canadian wildfires through Pennsylvania into the Mid Atlantic and the Northeast and kind of just dropping the smoke there. So what is it in this haze that makes it harmful? And I'm assuming it is harmful. It is. The levels outside right now in Baltimore are considered unhealthy. And most of that is due to what's called particulate matter, which are tiny particles, microscopic smaller than the width of your hair that can get into your lungs and impact your respiratory system, your cardiovascular system, and even your neurological your brain. What makes this particularly harmful? Is it the volume of particulant? Is it something in particular? What is it exactly? Can you just drill down on that a little bit more? Yeah. So the concentration of particulate matter I was looking at some of the monitors that we have was reaching levels of what are, in science, big 150 micrograms per meter cubed, which is more than ten times what the annual average should be and about four times higher than what you're supposed to have on a 24 hours average. And so the concentrations of these particles in the air are just much, much higher than we typically see. And exposure to those high levels can lead to a host of health problems. And who is most vulnerable? I noticed that in New York City, for example, they're canceling outdoor activities. And so here it is in the early days of summer, and they have to keep all the kids inside. So who tends to be vulnerable in a situation like this? It's the youngest. So children, obviously, whose bodies are still developing. The elderly, who are their bodies are more in decline and they're more susceptible to the health impacts of breathing, the poor air quality. And then people who have preexisting health conditions, people with respiratory conditions or heart conditions can be triggered by high levels of air pollution. Could this get worse? That's a good question. In some areas, it's much worse than others. And it just depends on kind of where the smoke is concentrated. I think New York has some of the higher concentrations right now, but that's going to change as that air moves away from the New York area. But over the course of the next few days, we will see different areas being hit at different times with the highest concentrations. I was going to ask you about more fires start burning. I don't expect the concentrations to go up too much higher. I was going to ask you how and you started to answer this, but how much longer could this last? Or forgive me if I'm asking you to speculate, but what do you think? Well, I think the fires are going to burn for a little bit longer, but the key for us in the US. Is the weather system changing. And so right now, it's kind of the weather systems that are pulling that air into our mid Atlantic and Northeast region. As those weather systems change and shift, we'll see that smoke going elsewhere and not impact us in this region as much. And so I think that's going to be the defining factor. And I think the next couple of days we're going to see a shift in that weather pattern and start to push the smoke away from where we are. And finally, with the impacts of climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences or circumstances? I mean, that is one of the predictions for climate change. Looking into the future, the fire season is starting earlier and lasting longer, and we're seeing more frequent fires. So, yeah, this is probably something that we'll be seeing more frequently. This tends to be much more of an issue in the Western US. So the eastern US. Getting hit right now is a little bit new. But yeah, I think with climate change moving forward, this is something that is going to happen more frequently. That's Peter De Carlo, associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University. Sergeant Carlo, thanks so much for joining us and sharing this expertise with us. Thank you for having me.", + "words": [ + { + "confidence": 0.97465, + "start": 250, + "end": 650, + "text": "Smoke", + "speaker": "speaker" + }, + { + "confidence": 0.99999, + "start": 730, + "end": 1022, + "text": "from", + "speaker": "speaker" + }, + { + "confidence": 0.99844, + "start": 1076, + "end": 1418, + "text": "hundreds", + "speaker": "speaker" + }, + { + "confidence": 0.84, + "start": 1434, + "end": 1614, + "text": "of", + "speaker": "speaker" + }, + { + "confidence": 0.89572, + "start": 1652, + "end": 2346, + "text": "wildfires", + "speaker": "speaker" + }, + { + "confidence": 0.99994, + "start": 2378, + "end": 2526, + "text": "in", + "speaker": "speaker" + }, + { + "confidence": 0.93953, + "start": 2548, + "end": 3130, + "text": "Canada", + "speaker": "speaker" + }, + { + "confidence": 0.999, + "start": 3210, + "end": 3454, + "text": "is", + "speaker": "speaker" + }, + { + "confidence": 0.74794, + "start": 3492, + "end": 3946, + "text": "triggering", + "speaker": "speaker" + }, + { + "confidence": 1, + "start": 3978, + "end": 4174, + "text": "air", + "speaker": "speaker" + }, + { + "confidence": 0.88077, + "start": 4212, + "end": 4558, + "text": "quality", + "speaker": "speaker" + }, + { + "confidence": 0.94814, + "start": 4644, + "end": 5114, + "text": "alerts", + "speaker": "speaker" + }, + { + "confidence": 0.99726, + "start": 5162, + "end": 5466, + "text": "throughout", + "speaker": "speaker" + }, + { + "confidence": 0.79, + "start": 5498, + "end": 5694, + "text": "the", + "speaker": "speaker" + }, + { + "confidence": 0.89, + "start": 5732, + "end": 6382, + "text": "US.", + "speaker": "speaker" + } + ], + "utterances": [ + { + "confidence": 0.9359033333333334, + "start": 250, + "end": 26950, + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor.", + "words": [ + { + "confidence": 0.97503, + "start": 250, + "end": 650, + "text": "Smoke", + "speaker": "A" + }, + { + "confidence": 0.99999, + "start": 730, + "end": 1022, + "text": "from", + "speaker": "A" + }, + { + "confidence": 0.99843, + "start": 1076, + "end": 1418, + "text": "hundreds", + "speaker": "A" + }, + { + "confidence": 0.85, + "start": 1434, + "end": 1614, + "text": "of", + "speaker": "A" + }, + { + "confidence": 0.89657, + "start": 1652, + "end": 2346, + "text": "wildfires", + "speaker": "A" + }, + { + "confidence": 0.99994, + "start": 2378, + "end": 2526, + "text": "in", + "speaker": "A" + }, + { + "confidence": 0.93864, + "start": 2548, + "end": 3130, + "text": "Canada", + "speaker": "A" + }, + { + "confidence": 0.999, + "start": 3210, + "end": 3454, + "text": "is", + "speaker": "A" + }, + { + "confidence": 0.75366, + "start": 3492, + "end": 3946, + "text": "triggering", + "speaker": "A" + }, + { + "confidence": 1, + "start": 3978, + "end": 4174, + "text": "air", + "speaker": "A" + }, + { + "confidence": 0.87745, + "start": 4212, + "end": 4558, + "text": "quality", + "speaker": "A" + }, + { + "confidence": 0.94739, + "start": 4644, + "end": 5114, + "text": "alerts", + "speaker": "A" + }, + { + "confidence": 0.99726, + "start": 5162, + "end": 5466, + "text": "throughout", + "speaker": "A" + }, + { + "confidence": 0.79, + "start": 5498, + "end": 5694, + "text": "the", + "speaker": "A" + }, + { + "confidence": 0.88, + "start": 5732, + "end": 6382, + "text": "US.", + "speaker": "A" + } + ], + "speaker": "A" + } + ], + "confidence": 0.9404651451800253, + "audio_duration": 281, + "punctuate": true, + "format_text": true, + "dual_channel": false, + "speech_model": "best", + "webhook_url": "https://your-webhook-url.tld/path", + "webhook_status_code": 200, + "webhook_auth_header_name": "webhook-secret", + "speed_boost": true, + "auto_highlights_result": { + "status": "success", + "results": [ + { + "count": 1, + "rank": 0.08, + "text": "air quality alerts", + "timestamps": [ + { + "start": 3978, + "end": 5114 + } + ] + }, + { + "count": 1, + "rank": 0.08, + "text": "wide ranging air quality consequences", + "timestamps": [ + { + "start": 235388, + "end": 238694 + } + ] + }, + { + "count": 1, + "rank": 0.07, + "text": "more wildfires", + "timestamps": [ + { + "start": 230972, + "end": 232354 + } + ] + }, + { + "count": 1, + "rank": 0.07, + "text": "air pollution", + "timestamps": [ + { + "start": 156004, + "end": 156910 + } + ] + }, + { + "count": 3, + "rank": 0.07, + "text": "weather systems", + "timestamps": [ + { + "start": 47344, + "end": 47958 + }, + { + "start": 205268, + "end": 205818 + }, + { + "start": 211588, + "end": 213434 + } + ] + }, + { + "count": 2, + "rank": 0.06, + "text": "high levels", + "timestamps": [ + { + "start": 121128, + "end": 121646 + }, + { + "start": 155412, + "end": 155866 + } + ] + }, + { + "count": 1, + "rank": 0.06, + "text": "health conditions", + "timestamps": [ + { + "start": 152138, + "end": 152666 + } + ] + }, + { + "count": 2, + "rank": 0.06, + "text": "Peter de Carlo", + "timestamps": [ + { + "start": 18948, + "end": 19930 + }, + { + "start": 268298, + "end": 269194 + } + ] + }, + { + "count": 1, + "rank": 0.06, + "text": "New York City", + "timestamps": [ + { + "start": 125768, + "end": 126274 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "respiratory conditions", + "timestamps": [ + { + "start": 152964, + "end": 153786 + } + ] + }, + { + "count": 3, + "rank": 0.05, + "text": "New York", + "timestamps": [ + { + "start": 125768, + "end": 126034 + }, + { + "start": 171448, + "end": 171938 + }, + { + "start": 176008, + "end": 176322 + } + ] + }, + { + "count": 3, + "rank": 0.05, + "text": "climate change", + "timestamps": [ + { + "start": 229548, + "end": 230230 + }, + { + "start": 244576, + "end": 245162 + }, + { + "start": 263348, + "end": 263950 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "Johns Hopkins University Varsity", + "timestamps": [ + { + "start": 23972, + "end": 25490 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "heart conditions", + "timestamps": [ + { + "start": 153988, + "end": 154506 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "air quality warnings", + "timestamps": [ + { + "start": 12308, + "end": 13434 + } + ] + } + ] + }, + "audio_start_from": 10, + "audio_end_at": 280, + "word_boost": [ + "aws", + "azure", + "google cloud" + ], + "boost_param": "high", + "filter_profanity": true, + "redact_pii_audio": true, + "redact_pii_audio_quality": "mp3", + "redact_pii_policies": [ + "us_social_security_number", + "credit_card_number" + ], + "redact_pii_sub": "hash", + "speaker_labels": true, + "speakers_expected": 2, + "content_safety": true, + "content_safety_labels": { + "status": "success", + "results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.", + "labels": [ + { + "label": "disasters", + "confidence": 0.8142836093902588, + "severity": 0.4093044400215149 + } + ], + "sentences_idx_start": 0, + "sentences_idx_end": 5, + "timestamp": { + "start": 250, + "end": 28840 + } + } + ], + "summary": { + "disasters": 0.9940800441842205, + "health_issues": 0.9216489289040967 + }, + "severity_score_summary": { + "disasters": { + "low": 0.5733263024656846, + "medium": 0.42667369753431533, + "high": 0 + }, + "health_issues": { + "low": 0.22863814977924785, + "medium": 0.45014154926938227, + "high": 0.32122030095136983 + } + } + }, + "iab_categories": true, + "iab_categories_result": { + "status": "success", + "results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.", + "labels": [ + { + "relevance": 0.988274097442627, + "label": "Home&Garden>IndoorEnvironmentalQuality" + }, + { + "relevance": 0.5821335911750793, + "label": "NewsAndPolitics>Weather" + }, + { + "relevance": 0.0042327106930315495, + "label": "MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth" + }, + { + "relevance": 0.0033971222583204508, + "label": "NewsAndPolitics>Disasters" + }, + { + "relevance": 0.002469958271831274, + "label": "BusinessAndFinance>Business>GreenSolutions" + }, + { + "relevance": 0.0014376690378412604, + "label": "MedicalHealth>DiseasesAndConditions>Cancer" + }, + { + "relevance": 0.0014294233405962586, + "label": "Science>Environment" + }, + { + "relevance": 0.001234519761055708, + "label": "Travel>TravelLocations>PolarTravel" + }, + { + "relevance": 0.0010231725173071027, + "label": "MedicalHealth>DiseasesAndConditions>ColdAndFlu" + }, + { + "relevance": 0.0007445293595083058, + "label": "BusinessAndFinance>Industries>PowerAndEnergyIndustry" + } + ], + "timestamp": { + "start": 250, + "end": 28840 + } + } + ], + "summary": { + "NewsAndPolitics>Weather": 1, + "Home&Garden>IndoorEnvironmentalQuality": 0.9043831825256348, + "Science>Environment": 0.16117265820503235, + "BusinessAndFinance>Industries>EnvironmentalServicesIndustry": 0.14393523335456848, + "MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth": 0.11401086300611496, + "BusinessAndFinance>Business>GreenSolutions": 0.06348437070846558, + "NewsAndPolitics>Disasters": 0.05041387677192688, + "Travel>TravelLocations>PolarTravel": 0.01308488193899393, + "HealthyLiving": 0.008222488686442375, + "MedicalHealth>DiseasesAndConditions>ColdAndFlu": 0.0022315620444715023, + "MedicalHealth>DiseasesAndConditions>HeartAndCardiovascularDiseases": 0.00213034451007843, + "HealthyLiving>Wellness>SmokingCessation": 0.001540527562610805, + "MedicalHealth>DiseasesAndConditions>Injuries": 0.0013950627762824297, + "BusinessAndFinance>Industries>PowerAndEnergyIndustry": 0.0012570273829624057, + "MedicalHealth>DiseasesAndConditions>Cancer": 0.001097781932912767, + "MedicalHealth>DiseasesAndConditions>Allergies": 0.0010148967849090695, + "MedicalHealth>DiseasesAndConditions>MentalHealth": 0.000717321818228811, + "Style&Fashion>PersonalCare>DeodorantAndAntiperspirant": 0.0006022014422342181, + "Technology&Computing>Computing>ComputerNetworking": 0.0005461975233629346, + "MedicalHealth>DiseasesAndConditions>Injuries>FirstAid": 0.0004885646631009877 + } + }, + "language_detection": false, + "custom_spelling": [ + { + "from": [ + "dicarlo" + ], + "to": "Decarlo" + } + ], + "auto_chapters": true, + "chapters": [ + { + "gist": "Smoggy air quality alerts across US", + "headline": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts across US", + "summary": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.", + "start": 250, + "end": 28840 + }, + { + "gist": "What is it about the conditions right now that have caused this round", + "headline": "High particulate matter in wildfire smoke can lead to serious health problems", + "summary": "Air pollution levels in Baltimore are considered unhealthy. Exposure to high levels can lead to a host of health problems. With climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences?", + "start": 29610, + "end": 280340 + } + ], + "summary_type": "bullets", + "summary_model": "informative", + "summary": "- Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.\\n- Air pollution levels in Baltimore are considered unhealthy. Exposure to high levels can lead to a host of health problems. With climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences?", + "custom_topics": true, + "topics": [ + "topics" + ], + "disfluencies": false, + "sentiment_analysis": true, + "sentiment_analysis_results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US.", + "start": 250, + "end": 6350, + "sentiment": "NEGATIVE", + "confidence": 0.8181032538414001, + "speaker": "speaker" + } + ], + "entity_detection": true, + "entities": [ + { + "entity_type": "location", + "text": "Canada", + "start": 2548, + "end": 3130 + }, + { + "entity_type": "location", + "text": "the US", + "start": 5498, + "end": 6382 + }, + { + "entity_type": "location", + "text": "Maine", + "start": 7492, + "end": 7914 + }, + { + "entity_type": "location", + "text": "Maryland", + "start": 8212, + "end": 8634 + }, + { + "entity_type": "location", + "text": "Minnesota", + "start": 8932, + "end": 9578 + }, + { + "entity_type": "person_name", + "text": "Peter de Carlo", + "start": 18948, + "end": 19930 + }, + { + "entity_type": "occupation", + "text": "associate professor", + "start": 20292, + "end": 21194 + }, + { + "entity_type": "organization", + "text": "Department of Environmental Health and Engineering", + "start": 21508, + "end": 23706 + }, + { + "entity_type": "organization", + "text": "Johns Hopkins University Varsity", + "start": 23972, + "end": 25490 + }, + { + "entity_type": "occupation", + "text": "professor", + "start": 26076, + "end": 26950 + }, + { + "entity_type": "location", + "text": "the US", + "start": 45184, + "end": 45898 + }, + { + "entity_type": "nationality", + "text": "Canadian", + "start": 49728, + "end": 50086 + } + ], + "speech_threshold": 0.5, + "throttled": true, + "error": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3\",\n \"audio_end_at\": 280,\n \"audio_start_from\": 10,\n \"auto_chapters\": true,\n \"auto_highlights\": true,\n \"boost_param\": \"high\",\n \"content_safety\": true,\n \"custom_spelling\": [\n {\n \"from\": [\n \"dicarlo\"\n ],\n \"to\": \"Decarlo\"\n }\n ],\n \"custom_topics\": true,\n \"disfluencies\": false,\n \"dual_channel\": true,\n \"entity_detection\": true,\n \"filter_profanity\": true,\n \"format_text\": true,\n \"iab_categories\": true,\n \"language_code\": \"en_us\",\n \"language_detection\": false,\n \"punctuate\": true,\n \"redact_pii\": true,\n \"redact_pii_audio\": true,\n \"redact_pii_audio_quality\": \"mp3\",\n \"redact_pii_policies\": [\n \"us_social_security_number\",\n \"credit_card_number\"\n ],\n \"redact_pii_sub\": \"hash\",\n \"sentiment_analysis\": true,\n \"speaker_labels\": true,\n \"speakers_expected\": 2,\n \"speech_threshold\": 0.5,\n \"summarization\": true,\n \"summary_model\": \"informative\",\n \"summary_type\": \"bullets\",\n \"topics\": [\n \"topics\"\n ],\n \"webhook_auth_header_name\": \"webhook-secret\",\n \"webhook_auth_header_value\": \"webhook-secret-value\",\n \"webhook_url\": \"https://your-webhook-url/path\",\n \"word_boost\": [\n \"aws\",\n \"azure\",\n \"google cloud\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "audio_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/transcript \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"audio_url\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.get": { + "id": "endpoint_transcripts.get", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Get the transcript resource. The transcript is ready when the \"status\" is \"completed\".", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v2/transcript/" + }, + { + "type": "pathParameter", + "value": "transcript_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the transcript" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:Transcript" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript/transcript_id", + "responseStatusCode": 200, + "pathParameters": { + "transcript_id": "transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "9ea68fd3-f953-42c1-9742-976c447fb463", + "language_model": "assemblyai_default", + "acoustic_model": "assemblyai_default", + "status": "completed", + "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3", + "webhook_auth": true, + "auto_highlights": true, + "redact_pii": true, + "summarization": true, + "language_code": "en_us", + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning. What is it about the conditions right now that have caused this round of wildfires to affect so many people so far away? Well, there's a couple of things. The season has been pretty dry already. And then the fact that we're getting hit in the US. Is because there's a couple of weather systems that are essentially channeling the smoke from those Canadian wildfires through Pennsylvania into the Mid Atlantic and the Northeast and kind of just dropping the smoke there. So what is it in this haze that makes it harmful? And I'm assuming it is harmful. It is. The levels outside right now in Baltimore are considered unhealthy. And most of that is due to what's called particulate matter, which are tiny particles, microscopic smaller than the width of your hair that can get into your lungs and impact your respiratory system, your cardiovascular system, and even your neurological your brain. What makes this particularly harmful? Is it the volume of particulant? Is it something in particular? What is it exactly? Can you just drill down on that a little bit more? Yeah. So the concentration of particulate matter I was looking at some of the monitors that we have was reaching levels of what are, in science, big 150 micrograms per meter cubed, which is more than ten times what the annual average should be and about four times higher than what you're supposed to have on a 24 hours average. And so the concentrations of these particles in the air are just much, much higher than we typically see. And exposure to those high levels can lead to a host of health problems. And who is most vulnerable? I noticed that in New York City, for example, they're canceling outdoor activities. And so here it is in the early days of summer, and they have to keep all the kids inside. So who tends to be vulnerable in a situation like this? It's the youngest. So children, obviously, whose bodies are still developing. The elderly, who are their bodies are more in decline and they're more susceptible to the health impacts of breathing, the poor air quality. And then people who have preexisting health conditions, people with respiratory conditions or heart conditions can be triggered by high levels of air pollution. Could this get worse? That's a good question. In some areas, it's much worse than others. And it just depends on kind of where the smoke is concentrated. I think New York has some of the higher concentrations right now, but that's going to change as that air moves away from the New York area. But over the course of the next few days, we will see different areas being hit at different times with the highest concentrations. I was going to ask you about more fires start burning. I don't expect the concentrations to go up too much higher. I was going to ask you how and you started to answer this, but how much longer could this last? Or forgive me if I'm asking you to speculate, but what do you think? Well, I think the fires are going to burn for a little bit longer, but the key for us in the US. Is the weather system changing. And so right now, it's kind of the weather systems that are pulling that air into our mid Atlantic and Northeast region. As those weather systems change and shift, we'll see that smoke going elsewhere and not impact us in this region as much. And so I think that's going to be the defining factor. And I think the next couple of days we're going to see a shift in that weather pattern and start to push the smoke away from where we are. And finally, with the impacts of climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences or circumstances? I mean, that is one of the predictions for climate change. Looking into the future, the fire season is starting earlier and lasting longer, and we're seeing more frequent fires. So, yeah, this is probably something that we'll be seeing more frequently. This tends to be much more of an issue in the Western US. So the eastern US. Getting hit right now is a little bit new. But yeah, I think with climate change moving forward, this is something that is going to happen more frequently. That's Peter De Carlo, associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University. Sergeant Carlo, thanks so much for joining us and sharing this expertise with us. Thank you for having me.", + "words": [ + { + "confidence": 0.97465, + "start": 250, + "end": 650, + "text": "Smoke", + "speaker": "speaker" + }, + { + "confidence": 0.99999, + "start": 730, + "end": 1022, + "text": "from", + "speaker": "speaker" + }, + { + "confidence": 0.99844, + "start": 1076, + "end": 1418, + "text": "hundreds", + "speaker": "speaker" + }, + { + "confidence": 0.84, + "start": 1434, + "end": 1614, + "text": "of", + "speaker": "speaker" + }, + { + "confidence": 0.89572, + "start": 1652, + "end": 2346, + "text": "wildfires", + "speaker": "speaker" + }, + { + "confidence": 0.99994, + "start": 2378, + "end": 2526, + "text": "in", + "speaker": "speaker" + }, + { + "confidence": 0.93953, + "start": 2548, + "end": 3130, + "text": "Canada", + "speaker": "speaker" + }, + { + "confidence": 0.999, + "start": 3210, + "end": 3454, + "text": "is", + "speaker": "speaker" + }, + { + "confidence": 0.74794, + "start": 3492, + "end": 3946, + "text": "triggering", + "speaker": "speaker" + }, + { + "confidence": 1, + "start": 3978, + "end": 4174, + "text": "air", + "speaker": "speaker" + }, + { + "confidence": 0.88077, + "start": 4212, + "end": 4558, + "text": "quality", + "speaker": "speaker" + }, + { + "confidence": 0.94814, + "start": 4644, + "end": 5114, + "text": "alerts", + "speaker": "speaker" + }, + { + "confidence": 0.99726, + "start": 5162, + "end": 5466, + "text": "throughout", + "speaker": "speaker" + }, + { + "confidence": 0.79, + "start": 5498, + "end": 5694, + "text": "the", + "speaker": "speaker" + }, + { + "confidence": 0.89, + "start": 5732, + "end": 6382, + "text": "US.", + "speaker": "speaker" + } + ], + "utterances": [ + { + "confidence": 0.9359033333333334, + "start": 250, + "end": 26950, + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor.", + "words": [ + { + "confidence": 0.97503, + "start": 250, + "end": 650, + "text": "Smoke", + "speaker": "A" + }, + { + "confidence": 0.99999, + "start": 730, + "end": 1022, + "text": "from", + "speaker": "A" + }, + { + "confidence": 0.99843, + "start": 1076, + "end": 1418, + "text": "hundreds", + "speaker": "A" + }, + { + "confidence": 0.85, + "start": 1434, + "end": 1614, + "text": "of", + "speaker": "A" + }, + { + "confidence": 0.89657, + "start": 1652, + "end": 2346, + "text": "wildfires", + "speaker": "A" + }, + { + "confidence": 0.99994, + "start": 2378, + "end": 2526, + "text": "in", + "speaker": "A" + }, + { + "confidence": 0.93864, + "start": 2548, + "end": 3130, + "text": "Canada", + "speaker": "A" + }, + { + "confidence": 0.999, + "start": 3210, + "end": 3454, + "text": "is", + "speaker": "A" + }, + { + "confidence": 0.75366, + "start": 3492, + "end": 3946, + "text": "triggering", + "speaker": "A" + }, + { + "confidence": 1, + "start": 3978, + "end": 4174, + "text": "air", + "speaker": "A" + }, + { + "confidence": 0.87745, + "start": 4212, + "end": 4558, + "text": "quality", + "speaker": "A" + }, + { + "confidence": 0.94739, + "start": 4644, + "end": 5114, + "text": "alerts", + "speaker": "A" + }, + { + "confidence": 0.99726, + "start": 5162, + "end": 5466, + "text": "throughout", + "speaker": "A" + }, + { + "confidence": 0.79, + "start": 5498, + "end": 5694, + "text": "the", + "speaker": "A" + }, + { + "confidence": 0.88, + "start": 5732, + "end": 6382, + "text": "US.", + "speaker": "A" + } + ], + "speaker": "A" + } + ], + "confidence": 0.9404651451800253, + "audio_duration": 281, + "punctuate": true, + "format_text": true, + "dual_channel": false, + "speech_model": "best", + "webhook_url": "https://your-webhook-url.tld/path", + "webhook_status_code": 200, + "webhook_auth_header_name": "webhook-secret", + "speed_boost": true, + "auto_highlights_result": { + "status": "success", + "results": [ + { + "count": 1, + "rank": 0.08, + "text": "air quality alerts", + "timestamps": [ + { + "start": 3978, + "end": 5114 + } + ] + }, + { + "count": 1, + "rank": 0.08, + "text": "wide ranging air quality consequences", + "timestamps": [ + { + "start": 235388, + "end": 238694 + } + ] + }, + { + "count": 1, + "rank": 0.07, + "text": "more wildfires", + "timestamps": [ + { + "start": 230972, + "end": 232354 + } + ] + }, + { + "count": 1, + "rank": 0.07, + "text": "air pollution", + "timestamps": [ + { + "start": 156004, + "end": 156910 + } + ] + }, + { + "count": 3, + "rank": 0.07, + "text": "weather systems", + "timestamps": [ + { + "start": 47344, + "end": 47958 + }, + { + "start": 205268, + "end": 205818 + }, + { + "start": 211588, + "end": 213434 + } + ] + }, + { + "count": 2, + "rank": 0.06, + "text": "high levels", + "timestamps": [ + { + "start": 121128, + "end": 121646 + }, + { + "start": 155412, + "end": 155866 + } + ] + }, + { + "count": 1, + "rank": 0.06, + "text": "health conditions", + "timestamps": [ + { + "start": 152138, + "end": 152666 + } + ] + }, + { + "count": 2, + "rank": 0.06, + "text": "Peter de Carlo", + "timestamps": [ + { + "start": 18948, + "end": 19930 + }, + { + "start": 268298, + "end": 269194 + } + ] + }, + { + "count": 1, + "rank": 0.06, + "text": "New York City", + "timestamps": [ + { + "start": 125768, + "end": 126274 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "respiratory conditions", + "timestamps": [ + { + "start": 152964, + "end": 153786 + } + ] + }, + { + "count": 3, + "rank": 0.05, + "text": "New York", + "timestamps": [ + { + "start": 125768, + "end": 126034 + }, + { + "start": 171448, + "end": 171938 + }, + { + "start": 176008, + "end": 176322 + } + ] + }, + { + "count": 3, + "rank": 0.05, + "text": "climate change", + "timestamps": [ + { + "start": 229548, + "end": 230230 + }, + { + "start": 244576, + "end": 245162 + }, + { + "start": 263348, + "end": 263950 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "Johns Hopkins University Varsity", + "timestamps": [ + { + "start": 23972, + "end": 25490 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "heart conditions", + "timestamps": [ + { + "start": 153988, + "end": 154506 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "air quality warnings", + "timestamps": [ + { + "start": 12308, + "end": 13434 + } + ] + } + ] + }, + "audio_start_from": 10, + "audio_end_at": 280, + "word_boost": [ + "aws", + "azure", + "google cloud" + ], + "boost_param": "high", + "filter_profanity": true, + "redact_pii_audio": true, + "redact_pii_audio_quality": "mp3", + "redact_pii_policies": [ + "us_social_security_number", + "credit_card_number" + ], + "redact_pii_sub": "hash", + "speaker_labels": true, + "speakers_expected": 2, + "content_safety": true, + "content_safety_labels": { + "status": "success", + "results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.", + "labels": [ + { + "label": "disasters", + "confidence": 0.8142836093902588, + "severity": 0.4093044400215149 + } + ], + "sentences_idx_start": 0, + "sentences_idx_end": 5, + "timestamp": { + "start": 250, + "end": 28840 + } + } + ], + "summary": { + "disasters": 0.9940800441842205, + "health_issues": 0.9216489289040967 + }, + "severity_score_summary": { + "disasters": { + "low": 0.5733263024656846, + "medium": 0.42667369753431533, + "high": 0 + }, + "health_issues": { + "low": 0.22863814977924785, + "medium": 0.45014154926938227, + "high": 0.32122030095136983 + } + } + }, + "iab_categories": true, + "iab_categories_result": { + "status": "success", + "results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.", + "labels": [ + { + "relevance": 0.988274097442627, + "label": "Home&Garden>IndoorEnvironmentalQuality" + }, + { + "relevance": 0.5821335911750793, + "label": "NewsAndPolitics>Weather" + }, + { + "relevance": 0.0042327106930315495, + "label": "MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth" + }, + { + "relevance": 0.0033971222583204508, + "label": "NewsAndPolitics>Disasters" + }, + { + "relevance": 0.002469958271831274, + "label": "BusinessAndFinance>Business>GreenSolutions" + }, + { + "relevance": 0.0014376690378412604, + "label": "MedicalHealth>DiseasesAndConditions>Cancer" + }, + { + "relevance": 0.0014294233405962586, + "label": "Science>Environment" + }, + { + "relevance": 0.001234519761055708, + "label": "Travel>TravelLocations>PolarTravel" + }, + { + "relevance": 0.0010231725173071027, + "label": "MedicalHealth>DiseasesAndConditions>ColdAndFlu" + }, + { + "relevance": 0.0007445293595083058, + "label": "BusinessAndFinance>Industries>PowerAndEnergyIndustry" + } + ], + "timestamp": { + "start": 250, + "end": 28840 + } + } + ], + "summary": { + "NewsAndPolitics>Weather": 1, + "Home&Garden>IndoorEnvironmentalQuality": 0.9043831825256348, + "Science>Environment": 0.16117265820503235, + "BusinessAndFinance>Industries>EnvironmentalServicesIndustry": 0.14393523335456848, + "MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth": 0.11401086300611496, + "BusinessAndFinance>Business>GreenSolutions": 0.06348437070846558, + "NewsAndPolitics>Disasters": 0.05041387677192688, + "Travel>TravelLocations>PolarTravel": 0.01308488193899393, + "HealthyLiving": 0.008222488686442375, + "MedicalHealth>DiseasesAndConditions>ColdAndFlu": 0.0022315620444715023, + "MedicalHealth>DiseasesAndConditions>HeartAndCardiovascularDiseases": 0.00213034451007843, + "HealthyLiving>Wellness>SmokingCessation": 0.001540527562610805, + "MedicalHealth>DiseasesAndConditions>Injuries": 0.0013950627762824297, + "BusinessAndFinance>Industries>PowerAndEnergyIndustry": 0.0012570273829624057, + "MedicalHealth>DiseasesAndConditions>Cancer": 0.001097781932912767, + "MedicalHealth>DiseasesAndConditions>Allergies": 0.0010148967849090695, + "MedicalHealth>DiseasesAndConditions>MentalHealth": 0.000717321818228811, + "Style&Fashion>PersonalCare>DeodorantAndAntiperspirant": 0.0006022014422342181, + "Technology&Computing>Computing>ComputerNetworking": 0.0005461975233629346, + "MedicalHealth>DiseasesAndConditions>Injuries>FirstAid": 0.0004885646631009877 + } + }, + "language_detection": false, + "custom_spelling": [ + { + "from": [ + "dicarlo" + ], + "to": "Decarlo" + } + ], + "auto_chapters": true, + "chapters": [ + { + "gist": "Smoggy air quality alerts across US", + "headline": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts across US", + "summary": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.", + "start": 250, + "end": 28840 + }, + { + "gist": "What is it about the conditions right now that have caused this round", + "headline": "High particulate matter in wildfire smoke can lead to serious health problems", + "summary": "Air pollution levels in Baltimore are considered unhealthy. Exposure to high levels can lead to a host of health problems. With climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences?", + "start": 29610, + "end": 280340 + } + ], + "summary_type": "bullets", + "summary_model": "informative", + "summary": "- Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.\\n- Air pollution levels in Baltimore are considered unhealthy. Exposure to high levels can lead to a host of health problems. With climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences?", + "custom_topics": true, + "topics": [ + "topics" + ], + "disfluencies": false, + "sentiment_analysis": true, + "sentiment_analysis_results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US.", + "start": 250, + "end": 6350, + "sentiment": "NEGATIVE", + "confidence": 0.8181032538414001, + "speaker": "speaker" + } + ], + "entity_detection": true, + "entities": [ + { + "entity_type": "location", + "text": "Canada", + "start": 2548, + "end": 3130 + }, + { + "entity_type": "location", + "text": "the US", + "start": 5498, + "end": 6382 + }, + { + "entity_type": "location", + "text": "Maine", + "start": 7492, + "end": 7914 + }, + { + "entity_type": "location", + "text": "Maryland", + "start": 8212, + "end": 8634 + }, + { + "entity_type": "location", + "text": "Minnesota", + "start": 8932, + "end": 9578 + }, + { + "entity_type": "person_name", + "text": "Peter de Carlo", + "start": 18948, + "end": 19930 + }, + { + "entity_type": "occupation", + "text": "associate professor", + "start": 20292, + "end": 21194 + }, + { + "entity_type": "organization", + "text": "Department of Environmental Health and Engineering", + "start": 21508, + "end": 23706 + }, + { + "entity_type": "organization", + "text": "Johns Hopkins University Varsity", + "start": 23972, + "end": 25490 + }, + { + "entity_type": "occupation", + "text": "professor", + "start": 26076, + "end": 26950 + }, + { + "entity_type": "location", + "text": "the US", + "start": 45184, + "end": 45898 + }, + { + "entity_type": "nationality", + "text": "Canadian", + "start": 49728, + "end": 50086 + } + ], + "speech_threshold": 0.5, + "throttled": true, + "error": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 400, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 401, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 404, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 429, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 500, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 503, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 504, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.delete": { + "id": "endpoint_transcripts.delete", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Delete the transcript.\nDeleting does not delete the resource itself, but removes the data from the resource and marks it as deleted.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v2/transcript/" + }, + { + "type": "pathParameter", + "value": "transcript_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the transcript" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:Transcript" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript/transcript_id", + "responseStatusCode": 200, + "pathParameters": { + "transcript_id": "transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "9ea68fd3-f953-42c1-9742-976c447fb463", + "language_model": "assemblyai_default", + "acoustic_model": "assemblyai_default", + "status": "completed", + "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3", + "webhook_auth": true, + "auto_highlights": true, + "redact_pii": true, + "summarization": true, + "language_code": "en_us", + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning. What is it about the conditions right now that have caused this round of wildfires to affect so many people so far away? Well, there's a couple of things. The season has been pretty dry already. And then the fact that we're getting hit in the US. Is because there's a couple of weather systems that are essentially channeling the smoke from those Canadian wildfires through Pennsylvania into the Mid Atlantic and the Northeast and kind of just dropping the smoke there. So what is it in this haze that makes it harmful? And I'm assuming it is harmful. It is. The levels outside right now in Baltimore are considered unhealthy. And most of that is due to what's called particulate matter, which are tiny particles, microscopic smaller than the width of your hair that can get into your lungs and impact your respiratory system, your cardiovascular system, and even your neurological your brain. What makes this particularly harmful? Is it the volume of particulant? Is it something in particular? What is it exactly? Can you just drill down on that a little bit more? Yeah. So the concentration of particulate matter I was looking at some of the monitors that we have was reaching levels of what are, in science, big 150 micrograms per meter cubed, which is more than ten times what the annual average should be and about four times higher than what you're supposed to have on a 24 hours average. And so the concentrations of these particles in the air are just much, much higher than we typically see. And exposure to those high levels can lead to a host of health problems. And who is most vulnerable? I noticed that in New York City, for example, they're canceling outdoor activities. And so here it is in the early days of summer, and they have to keep all the kids inside. So who tends to be vulnerable in a situation like this? It's the youngest. So children, obviously, whose bodies are still developing. The elderly, who are their bodies are more in decline and they're more susceptible to the health impacts of breathing, the poor air quality. And then people who have preexisting health conditions, people with respiratory conditions or heart conditions can be triggered by high levels of air pollution. Could this get worse? That's a good question. In some areas, it's much worse than others. And it just depends on kind of where the smoke is concentrated. I think New York has some of the higher concentrations right now, but that's going to change as that air moves away from the New York area. But over the course of the next few days, we will see different areas being hit at different times with the highest concentrations. I was going to ask you about more fires start burning. I don't expect the concentrations to go up too much higher. I was going to ask you how and you started to answer this, but how much longer could this last? Or forgive me if I'm asking you to speculate, but what do you think? Well, I think the fires are going to burn for a little bit longer, but the key for us in the US. Is the weather system changing. And so right now, it's kind of the weather systems that are pulling that air into our mid Atlantic and Northeast region. As those weather systems change and shift, we'll see that smoke going elsewhere and not impact us in this region as much. And so I think that's going to be the defining factor. And I think the next couple of days we're going to see a shift in that weather pattern and start to push the smoke away from where we are. And finally, with the impacts of climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences or circumstances? I mean, that is one of the predictions for climate change. Looking into the future, the fire season is starting earlier and lasting longer, and we're seeing more frequent fires. So, yeah, this is probably something that we'll be seeing more frequently. This tends to be much more of an issue in the Western US. So the eastern US. Getting hit right now is a little bit new. But yeah, I think with climate change moving forward, this is something that is going to happen more frequently. That's Peter De Carlo, associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University. Sergeant Carlo, thanks so much for joining us and sharing this expertise with us. Thank you for having me.", + "words": [ + { + "confidence": 0.97465, + "start": 250, + "end": 650, + "text": "Smoke", + "speaker": "speaker" + }, + { + "confidence": 0.99999, + "start": 730, + "end": 1022, + "text": "from", + "speaker": "speaker" + }, + { + "confidence": 0.99844, + "start": 1076, + "end": 1418, + "text": "hundreds", + "speaker": "speaker" + }, + { + "confidence": 0.84, + "start": 1434, + "end": 1614, + "text": "of", + "speaker": "speaker" + }, + { + "confidence": 0.89572, + "start": 1652, + "end": 2346, + "text": "wildfires", + "speaker": "speaker" + }, + { + "confidence": 0.99994, + "start": 2378, + "end": 2526, + "text": "in", + "speaker": "speaker" + }, + { + "confidence": 0.93953, + "start": 2548, + "end": 3130, + "text": "Canada", + "speaker": "speaker" + }, + { + "confidence": 0.999, + "start": 3210, + "end": 3454, + "text": "is", + "speaker": "speaker" + }, + { + "confidence": 0.74794, + "start": 3492, + "end": 3946, + "text": "triggering", + "speaker": "speaker" + }, + { + "confidence": 1, + "start": 3978, + "end": 4174, + "text": "air", + "speaker": "speaker" + }, + { + "confidence": 0.88077, + "start": 4212, + "end": 4558, + "text": "quality", + "speaker": "speaker" + }, + { + "confidence": 0.94814, + "start": 4644, + "end": 5114, + "text": "alerts", + "speaker": "speaker" + }, + { + "confidence": 0.99726, + "start": 5162, + "end": 5466, + "text": "throughout", + "speaker": "speaker" + }, + { + "confidence": 0.79, + "start": 5498, + "end": 5694, + "text": "the", + "speaker": "speaker" + }, + { + "confidence": 0.89, + "start": 5732, + "end": 6382, + "text": "US.", + "speaker": "speaker" + } + ], + "utterances": [ + { + "confidence": 0.9359033333333334, + "start": 250, + "end": 26950, + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor.", + "words": [ + { + "confidence": 0.97503, + "start": 250, + "end": 650, + "text": "Smoke", + "speaker": "A" + }, + { + "confidence": 0.99999, + "start": 730, + "end": 1022, + "text": "from", + "speaker": "A" + }, + { + "confidence": 0.99843, + "start": 1076, + "end": 1418, + "text": "hundreds", + "speaker": "A" + }, + { + "confidence": 0.85, + "start": 1434, + "end": 1614, + "text": "of", + "speaker": "A" + }, + { + "confidence": 0.89657, + "start": 1652, + "end": 2346, + "text": "wildfires", + "speaker": "A" + }, + { + "confidence": 0.99994, + "start": 2378, + "end": 2526, + "text": "in", + "speaker": "A" + }, + { + "confidence": 0.93864, + "start": 2548, + "end": 3130, + "text": "Canada", + "speaker": "A" + }, + { + "confidence": 0.999, + "start": 3210, + "end": 3454, + "text": "is", + "speaker": "A" + }, + { + "confidence": 0.75366, + "start": 3492, + "end": 3946, + "text": "triggering", + "speaker": "A" + }, + { + "confidence": 1, + "start": 3978, + "end": 4174, + "text": "air", + "speaker": "A" + }, + { + "confidence": 0.87745, + "start": 4212, + "end": 4558, + "text": "quality", + "speaker": "A" + }, + { + "confidence": 0.94739, + "start": 4644, + "end": 5114, + "text": "alerts", + "speaker": "A" + }, + { + "confidence": 0.99726, + "start": 5162, + "end": 5466, + "text": "throughout", + "speaker": "A" + }, + { + "confidence": 0.79, + "start": 5498, + "end": 5694, + "text": "the", + "speaker": "A" + }, + { + "confidence": 0.88, + "start": 5732, + "end": 6382, + "text": "US.", + "speaker": "A" + } + ], + "speaker": "A" + } + ], + "confidence": 0.9404651451800253, + "audio_duration": 281, + "punctuate": true, + "format_text": true, + "dual_channel": false, + "speech_model": "best", + "webhook_url": "https://your-webhook-url.tld/path", + "webhook_status_code": 200, + "webhook_auth_header_name": "webhook-secret", + "speed_boost": true, + "auto_highlights_result": { + "status": "success", + "results": [ + { + "count": 1, + "rank": 0.08, + "text": "air quality alerts", + "timestamps": [ + { + "start": 3978, + "end": 5114 + } + ] + }, + { + "count": 1, + "rank": 0.08, + "text": "wide ranging air quality consequences", + "timestamps": [ + { + "start": 235388, + "end": 238694 + } + ] + }, + { + "count": 1, + "rank": 0.07, + "text": "more wildfires", + "timestamps": [ + { + "start": 230972, + "end": 232354 + } + ] + }, + { + "count": 1, + "rank": 0.07, + "text": "air pollution", + "timestamps": [ + { + "start": 156004, + "end": 156910 + } + ] + }, + { + "count": 3, + "rank": 0.07, + "text": "weather systems", + "timestamps": [ + { + "start": 47344, + "end": 47958 + }, + { + "start": 205268, + "end": 205818 + }, + { + "start": 211588, + "end": 213434 + } + ] + }, + { + "count": 2, + "rank": 0.06, + "text": "high levels", + "timestamps": [ + { + "start": 121128, + "end": 121646 + }, + { + "start": 155412, + "end": 155866 + } + ] + }, + { + "count": 1, + "rank": 0.06, + "text": "health conditions", + "timestamps": [ + { + "start": 152138, + "end": 152666 + } + ] + }, + { + "count": 2, + "rank": 0.06, + "text": "Peter de Carlo", + "timestamps": [ + { + "start": 18948, + "end": 19930 + }, + { + "start": 268298, + "end": 269194 + } + ] + }, + { + "count": 1, + "rank": 0.06, + "text": "New York City", + "timestamps": [ + { + "start": 125768, + "end": 126274 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "respiratory conditions", + "timestamps": [ + { + "start": 152964, + "end": 153786 + } + ] + }, + { + "count": 3, + "rank": 0.05, + "text": "New York", + "timestamps": [ + { + "start": 125768, + "end": 126034 + }, + { + "start": 171448, + "end": 171938 + }, + { + "start": 176008, + "end": 176322 + } + ] + }, + { + "count": 3, + "rank": 0.05, + "text": "climate change", + "timestamps": [ + { + "start": 229548, + "end": 230230 + }, + { + "start": 244576, + "end": 245162 + }, + { + "start": 263348, + "end": 263950 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "Johns Hopkins University Varsity", + "timestamps": [ + { + "start": 23972, + "end": 25490 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "heart conditions", + "timestamps": [ + { + "start": 153988, + "end": 154506 + } + ] + }, + { + "count": 1, + "rank": 0.05, + "text": "air quality warnings", + "timestamps": [ + { + "start": 12308, + "end": 13434 + } + ] + } + ] + }, + "audio_start_from": 10, + "audio_end_at": 280, + "word_boost": [ + "aws", + "azure", + "google cloud" + ], + "boost_param": "high", + "filter_profanity": true, + "redact_pii_audio": true, + "redact_pii_audio_quality": "mp3", + "redact_pii_policies": [ + "us_social_security_number", + "credit_card_number" + ], + "redact_pii_sub": "hash", + "speaker_labels": true, + "speakers_expected": 2, + "content_safety": true, + "content_safety_labels": { + "status": "success", + "results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.", + "labels": [ + { + "label": "disasters", + "confidence": 0.8142836093902588, + "severity": 0.4093044400215149 + } + ], + "sentences_idx_start": 0, + "sentences_idx_end": 5, + "timestamp": { + "start": 250, + "end": 28840 + } + } + ], + "summary": { + "disasters": 0.9940800441842205, + "health_issues": 0.9216489289040967 + }, + "severity_score_summary": { + "disasters": { + "low": 0.5733263024656846, + "medium": 0.42667369753431533, + "high": 0 + }, + "health_issues": { + "low": 0.22863814977924785, + "medium": 0.45014154926938227, + "high": 0.32122030095136983 + } + } + }, + "iab_categories": true, + "iab_categories_result": { + "status": "success", + "results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.", + "labels": [ + { + "relevance": 0.988274097442627, + "label": "Home&Garden>IndoorEnvironmentalQuality" + }, + { + "relevance": 0.5821335911750793, + "label": "NewsAndPolitics>Weather" + }, + { + "relevance": 0.0042327106930315495, + "label": "MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth" + }, + { + "relevance": 0.0033971222583204508, + "label": "NewsAndPolitics>Disasters" + }, + { + "relevance": 0.002469958271831274, + "label": "BusinessAndFinance>Business>GreenSolutions" + }, + { + "relevance": 0.0014376690378412604, + "label": "MedicalHealth>DiseasesAndConditions>Cancer" + }, + { + "relevance": 0.0014294233405962586, + "label": "Science>Environment" + }, + { + "relevance": 0.001234519761055708, + "label": "Travel>TravelLocations>PolarTravel" + }, + { + "relevance": 0.0010231725173071027, + "label": "MedicalHealth>DiseasesAndConditions>ColdAndFlu" + }, + { + "relevance": 0.0007445293595083058, + "label": "BusinessAndFinance>Industries>PowerAndEnergyIndustry" + } + ], + "timestamp": { + "start": 250, + "end": 28840 + } + } + ], + "summary": { + "NewsAndPolitics>Weather": 1, + "Home&Garden>IndoorEnvironmentalQuality": 0.9043831825256348, + "Science>Environment": 0.16117265820503235, + "BusinessAndFinance>Industries>EnvironmentalServicesIndustry": 0.14393523335456848, + "MedicalHealth>DiseasesAndConditions>LungAndRespiratoryHealth": 0.11401086300611496, + "BusinessAndFinance>Business>GreenSolutions": 0.06348437070846558, + "NewsAndPolitics>Disasters": 0.05041387677192688, + "Travel>TravelLocations>PolarTravel": 0.01308488193899393, + "HealthyLiving": 0.008222488686442375, + "MedicalHealth>DiseasesAndConditions>ColdAndFlu": 0.0022315620444715023, + "MedicalHealth>DiseasesAndConditions>HeartAndCardiovascularDiseases": 0.00213034451007843, + "HealthyLiving>Wellness>SmokingCessation": 0.001540527562610805, + "MedicalHealth>DiseasesAndConditions>Injuries": 0.0013950627762824297, + "BusinessAndFinance>Industries>PowerAndEnergyIndustry": 0.0012570273829624057, + "MedicalHealth>DiseasesAndConditions>Cancer": 0.001097781932912767, + "MedicalHealth>DiseasesAndConditions>Allergies": 0.0010148967849090695, + "MedicalHealth>DiseasesAndConditions>MentalHealth": 0.000717321818228811, + "Style&Fashion>PersonalCare>DeodorantAndAntiperspirant": 0.0006022014422342181, + "Technology&Computing>Computing>ComputerNetworking": 0.0005461975233629346, + "MedicalHealth>DiseasesAndConditions>Injuries>FirstAid": 0.0004885646631009877 + } + }, + "language_detection": false, + "custom_spelling": [ + { + "from": [ + "dicarlo" + ], + "to": "Decarlo" + } + ], + "auto_chapters": true, + "chapters": [ + { + "gist": "Smoggy air quality alerts across US", + "headline": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts across US", + "summary": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.", + "start": 250, + "end": 28840 + }, + { + "gist": "What is it about the conditions right now that have caused this round", + "headline": "High particulate matter in wildfire smoke can lead to serious health problems", + "summary": "Air pollution levels in Baltimore are considered unhealthy. Exposure to high levels can lead to a host of health problems. With climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences?", + "start": 29610, + "end": 280340 + } + ], + "summary_type": "bullets", + "summary_model": "informative", + "summary": "- Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.\\n- Air pollution levels in Baltimore are considered unhealthy. Exposure to high levels can lead to a host of health problems. With climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences?", + "custom_topics": true, + "topics": [ + "topics" + ], + "disfluencies": false, + "sentiment_analysis": true, + "sentiment_analysis_results": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US.", + "start": 250, + "end": 6350, + "sentiment": "NEGATIVE", + "confidence": 0.8181032538414001, + "speaker": "speaker" + } + ], + "entity_detection": true, + "entities": [ + { + "entity_type": "location", + "text": "Canada", + "start": 2548, + "end": 3130 + }, + { + "entity_type": "location", + "text": "the US", + "start": 5498, + "end": 6382 + }, + { + "entity_type": "location", + "text": "Maine", + "start": 7492, + "end": 7914 + }, + { + "entity_type": "location", + "text": "Maryland", + "start": 8212, + "end": 8634 + }, + { + "entity_type": "location", + "text": "Minnesota", + "start": 8932, + "end": 9578 + }, + { + "entity_type": "person_name", + "text": "Peter de Carlo", + "start": 18948, + "end": 19930 + }, + { + "entity_type": "occupation", + "text": "associate professor", + "start": 20292, + "end": 21194 + }, + { + "entity_type": "organization", + "text": "Department of Environmental Health and Engineering", + "start": 21508, + "end": 23706 + }, + { + "entity_type": "organization", + "text": "Johns Hopkins University Varsity", + "start": 23972, + "end": 25490 + }, + { + "entity_type": "occupation", + "text": "professor", + "start": 26076, + "end": 26950 + }, + { + "entity_type": "location", + "text": "the US", + "start": 45184, + "end": 45898 + }, + { + "entity_type": "nationality", + "text": "Canadian", + "start": 49728, + "end": 50086 + } + ], + "speech_threshold": 0.5, + "throttled": true, + "error": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 400, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 401, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 404, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 429, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 500, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 503, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id", + "responseStatusCode": 504, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/v2/transcript/:transcript_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.getSubtitles": { + "id": "endpoint_transcripts.getSubtitles", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Export your transcript in SRT or VTT format to use with a video player for subtitles and closed captions.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v2/transcript/" + }, + { + "type": "pathParameter", + "value": "transcript_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "subtitle_format" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the transcript" + }, + { + "key": "subtitle_format", + "valueShape": { + "type": "id", + "id": "type_transcripts:SubtitleFormat" + }, + "description": "The format of the captions" + } + ], + "queryParameters": [ + { + "key": "chars_per_caption", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of characters per caption" + } + ], + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 200, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 400, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 401, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 404, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 429, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 500, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 503, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/srt", + "responseStatusCode": 504, + "pathParameters": { + "transcript_id": ":transcript_id", + "subtitle_format": "srt" + }, + "queryParameters": { + "chars_per_caption": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/srt \\\n -H \"Authorization: \" \\\n -d chars_per_caption=0", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.getSentences": { + "id": "endpoint_transcripts.getSentences", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Get the transcript split by sentences. The API will attempt to semantically segment the transcript into sentences to create more reader-friendly transcripts.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v2/transcript/" + }, + { + "type": "pathParameter", + "value": "transcript_id" + }, + { + "type": "literal", + "value": "/sentences" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the transcript" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:SentencesResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript/transcript_id/sentences", + "responseStatusCode": 200, + "pathParameters": { + "transcript_id": "transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "d5a3d302-066e-43fb-b63b-8f57baf185db", + "confidence": 0.9579390654205628, + "audio_duration": 281, + "sentences": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US.", + "start": 250, + "end": 6350, + "confidence": 0.72412, + "words": [ + { + "confidence": 0.72412, + "start": 250, + "end": 650, + "text": "Smoke" + }, + { + "confidence": 0.99996, + "start": 730, + "end": 1022, + "text": "from" + }, + { + "confidence": 0.99992, + "start": 1076, + "end": 1466, + "text": "hundreds" + }, + { + "confidence": 1, + "start": 1498, + "end": 1646, + "text": "of" + } + ], + "speaker": "speaker" + }, + { + "text": "Skylines from Maine to Maryland to Minnesota are gray and smoggy.", + "start": 6500, + "end": 11050, + "confidence": 0.99819, + "words": [ + { + "confidence": 0.99819, + "start": 6500, + "end": 7306, + "text": "Skylines" + }, + { + "confidence": 0.99987, + "start": 7338, + "end": 7534, + "text": "from" + }, + { + "confidence": 0.9972, + "start": 7572, + "end": 7962, + "text": "Maine" + }, + { + "confidence": 1, + "start": 8026, + "end": 8206, + "text": "to" + }, + { + "confidence": 0.5192, + "start": 8228, + "end": 8650, + "text": "Maryland" + }, + { + "confidence": 1, + "start": 8730, + "end": 8926, + "text": "to" + } + ], + "speaker": "speaker" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/sentences", + "responseStatusCode": 400, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/sentences", + "responseStatusCode": 401, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/sentences", + "responseStatusCode": 404, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/sentences", + "responseStatusCode": 429, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/sentences", + "responseStatusCode": 500, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/sentences", + "responseStatusCode": 503, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/sentences", + "responseStatusCode": 504, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/sentences \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.getParagraphs": { + "id": "endpoint_transcripts.getParagraphs", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Get the transcript split by paragraphs. The API will attempt to semantically segment your transcript into paragraphs to create more reader-friendly transcripts.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v2/transcript/" + }, + { + "type": "pathParameter", + "value": "transcript_id" + }, + { + "type": "literal", + "value": "/paragraphs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the transcript" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:ParagraphsResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript/transcript_id/paragraphs", + "responseStatusCode": 200, + "pathParameters": { + "transcript_id": "transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "d5a3d302-066e-43fb-b63b-8f57baf185db", + "confidence": 0.9578730257009361, + "audio_duration": 281, + "paragraphs": [ + { + "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter Decarlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University. Good morning, professor.", + "start": 250, + "end": 26950, + "confidence": 0.73033, + "words": [ + { + "confidence": 0.73033, + "start": 250, + "end": 650, + "text": "Smoke" + }, + { + "confidence": 1, + "start": 730, + "end": 1022, + "text": "from" + }, + { + "confidence": 0.99992, + "start": 1076, + "end": 1466, + "text": "hundreds" + }, + { + "confidence": 1, + "start": 1498, + "end": 1646, + "text": "of" + } + ], + "speaker": "speaker" + }, + { + "text": "Good morning. So what is it about the conditions right now that have caused this round of wildfires to affect so many people so far away? Well, there's a couple of things. The season has been pretty dry already, and then the fact that we're getting hit in the US. Is because there's a couple of weather systems that are essentially channeling the smoke from those Canadian wildfires through Pennsylvania into the Mid Atlantic and the Northeast and kind of just dropping the smoke there.", + "start": 27850, + "end": 56190, + "confidence": 0.99667, + "words": [ + { + "confidence": 0.99667, + "start": 27850, + "end": 28262, + "text": "Good" + }, + { + "confidence": 0.99742, + "start": 28316, + "end": 28920, + "text": "morning." + }, + { + "confidence": 0.94736, + "start": 29290, + "end": 29702, + "text": "So" + } + ], + "speaker": "speaker" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/paragraphs", + "responseStatusCode": 400, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/paragraphs", + "responseStatusCode": 401, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/paragraphs", + "responseStatusCode": 404, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/paragraphs", + "responseStatusCode": 429, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/paragraphs", + "responseStatusCode": 500, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/paragraphs", + "responseStatusCode": 503, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/paragraphs", + "responseStatusCode": 504, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/paragraphs \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.wordSearch": { + "id": "endpoint_transcripts.wordSearch", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Search through the transcript for keywords. You can search for individual words, numbers, or phrases containing up to five words or numbers.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v2/transcript/" + }, + { + "type": "pathParameter", + "value": "transcript_id" + }, + { + "type": "literal", + "value": "/word-search" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the transcript" + } + ], + "queryParameters": [ + { + "key": "words", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Keywords to search for" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:WordSearchResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 200, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "string", + "total_count": 0, + "matches": [ + { + "text": "string", + "count": 0, + "timestamps": [ + [ + 0 + ] + ], + "indexes": [ + 0 + ] + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 400, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 401, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 404, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 429, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 500, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 503, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/word-search", + "responseStatusCode": 504, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": { + "words": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.assemblyai.com/v2/transcript/:transcript_id/word-search \\\n -H \"Authorization: \" \\\n -d words=string", + "generated": true + } + ] + } + } + ] + }, + "endpoint_transcripts.getRedactedAudio": { + "id": "endpoint_transcripts.getRedactedAudio", + "namespace": [ + "subpackage_transcripts" + ], + "description": "Retrieve the redacted audio object containing the status and URL to the redacted audio.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v2/transcript/" + }, + { + "type": "pathParameter", + "value": "transcript_id" + }, + { + "type": "literal", + "value": "/redacted-audio" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the transcript" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_transcripts:RedactedAudioResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/transcript/transcript_id/redacted-audio", + "responseStatusCode": 200, + "pathParameters": { + "transcript_id": "transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "redacted_audio_ready", + "redacted_audio_url": "https://s3.us-west-2.amazonaws.com/api.assembly.ai.usw2/redacted-audio/785efd9e-0e20-45e1-967b-3db17770ed9f.wav?AWSAccessKeyId=ASIAVASQFLPGLUP5JD7Y&Signature=z1r2MOA46esiiAmk%2FreBkL8rl6g%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEPv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIHxKoUJdd5P%2Fdy4WlfvRNppQtauTy7OuAb5azR2OIoYSAiEA8iPx4xAx0pbZztT4e7fGnzPS4phvNCnYKflIijUoxDsq%2BwMIMxAEGgwzNDQ4MzkyNDg4NDQiDJxsCgo0cDg789FV0CrYAwPK3CHbRHoNPFiQ%2FO6EdHZ4OSFRcS%2FDvDyHQRNnYNSwG4JB2mUMWEVw808JWTya%2But4wEcmPiUCVJMTvh70cxhILAxP84CBTuWGM%2Fszbj4tn1thjVsqovf9YZmP17OCFa77Bc9%2F9RwtRaABEqJ2eb6%2Bsir7w0MMzhe1z%2F%2B1PUKxicJAZasBv3Ova%2BTY2eNkPZHQ4Njie4X5sh05b%2BrKnz58E7GTQ1sHZQDYHZecwb5fP0B3LR0vuqNtK%2BdpMAxw5H7BinQ4rdccLmsLLMQeVn8jdRDZNEvsdmoeQL0y0qD%2BUcyGMJoAjMT4FnXhBhVxc3bgkVUbHlZMn48FNCYcmzM8UB9wGmSnr6iQoqEaFElfQVbvAzsW7lnlfLROZxMvGXyliobPYPSaYZlVYgHcIxeWuOAXRtEtmL2jbaX4ghCVgJBVO3BBzTgub2jB0KPU6lYZLLM4kf%2B8hKX8iyxSRc6ZVEefTcyruoDppjB028pA9q75hLH1CZwhfLoM%2F3z5f0aFCl05zQnaa10nbcKj0hERELf4FXqS8yWbSutlRcd7Rr9o8jN31QGUscpsuIvl%2FpyJcZmItX8nO%2FF0s1QjrIi11DLYD9YoOh7eVkN8eKKn5w4cHldVI2sw4NCPqgY6pQE%2BM9va2ad1%2BNrXeQ9t8K41lojTN0BFmM8ERD5fF77xcTlW8VdV%2FiJeLLHDvnYYWVKcga9hSROlmsqvMyn3Tmhz7KQbIepSAOKhcHM%2FyUaLfErvCtjXGwo8nsKForL7SKiGkaRCBmwfQtkSVP6m4tGT50YdGxakh54f8uyC55SbkElknRbpl5haiZ%2F82UddFBkdPcM3t0s7vwbEy%2BbilYyetOr6htc%3D&Expires=1698966551" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/redacted-audio", + "responseStatusCode": 400, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/redacted-audio", + "responseStatusCode": 401, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/redacted-audio", + "responseStatusCode": 404, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/redacted-audio", + "responseStatusCode": 429, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/redacted-audio", + "responseStatusCode": 500, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "error", + "error": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/redacted-audio", + "responseStatusCode": 503, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/v2/transcript/:transcript_id/redacted-audio", + "responseStatusCode": 504, + "pathParameters": { + "transcript_id": ":transcript_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.assemblyai.com/v2/transcript/:transcript_id/redacted-audio \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_lemur.task": { + "id": "endpoint_lemur.task", + "namespace": [ + "subpackage_lemur" + ], + "description": "Use the LeMUR task endpoint to input your own LLM prompt.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/lemur/v3/generate/task" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseParams" + ], + "properties": [ + { + "key": "prompt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Your text to prompt the model to produce a desired output, including any context you want to pass into the model." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_lemur:LemurTaskResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "List all the locations affected by wildfires.", + "context": "This is an interview about wildfires.", + "final_model": "default", + "max_output_size": 3000, + "temperature": 0, + "transcript_ids": [ + "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e", + "response": "Based on the transcript, the following locations were mentioned as being affected by wildfire smoke from Canada:\n\n- Maine\n- Maryland\n- Minnesota\n- Mid Atlantic region\n- Northeast region\n- New York City\n- Baltimore\n" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"List all the locations affected by wildfires.\",\n \"context\": \"This is an interview about wildfires.\",\n \"final_model\": \"default\",\n \"max_output_size\": 3000,\n \"temperature\": 0,\n \"transcript_ids\": [\n \"64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/task", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/task \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_lemur.summary": { + "id": "endpoint_lemur.summary", + "namespace": [ + "subpackage_lemur" + ], + "description": "Custom Summary allows you to distill a piece of audio into a few impactful sentences.\nYou can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/lemur/v3/generate/summary" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseParams" + ], + "properties": [ + { + "key": "answer_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "How you want the summary to be returned. This can be any text. Examples: \"TLDR\", \"bullet points\"\n" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_lemur:LemurSummaryResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "context": "This is an interview about wildfires.", + "final_model": "default", + "max_output_size": 3000, + "temperature": 0, + "transcript_ids": [ + "47b95ba5-8889-44d8-bc80-5de38306e582" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e", + "response": "- Wildfires in Canada are sending smoke and air pollution across parts of the US, triggering air quality alerts from Maine to Minnesota. Concentrations of particulate matter have exceeded safety levels.\n\n- Weather systems are channeling the smoke through Pennsylvania into the Mid-Atlantic and Northeast regions. New York City has canceled outdoor activities to keep children and vulnerable groups indoors.\n\n- Very small particulate matter can enter the lungs and impact respiratory, cardiovascular and neurological health. Young children, the elderly and those with preexisting conditions are most at risk.\n\n- The conditions causing the poor air quality could get worse or shift to different areas in coming days depending on weather patterns. More wildfires may also contribute to higher concentrations.\n\n- Climate change is leading to longer and more severe fire seasons. Events of smoke traveling long distances and affecting air quality over wide areas will likely become more common in the future.\"\n" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"context\": \"This is an interview about wildfires.\",\n \"final_model\": \"default\",\n \"max_output_size\": 3000,\n \"temperature\": 0,\n \"transcript_ids\": [\n \"47b95ba5-8889-44d8-bc80-5de38306e582\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/summary", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/summary \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_lemur.questionAnswer": { + "id": "endpoint_lemur.questionAnswer", + "namespace": [ + "subpackage_lemur" + ], + "description": "Question & Answer allows you to ask free-form questions about a single transcript or a group of transcripts.\nThe questions can be any whose answers you find useful, such as judging whether a caller is likely to become a customer or whether all items on a meeting's agenda were covered.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/lemur/v3/generate/question-answer" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseParams" + ], + "properties": [ + { + "key": "questions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_lemur:LemurQuestion" + } + }, + "description": "A list of questions to ask" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_lemur:LemurQuestionAnswerResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "Where are there wildfires?", + "answer_format": "List of countries in ISO 3166-1 alpha-2 format", + "answer_options": [ + "US", + "CA" + ] + }, + { + "question": "Is global warming affecting wildfires?", + "answer_options": [ + "yes", + "no" + ] + } + ], + "context": "This is an interview about wildfires.", + "final_model": "default", + "max_output_size": 3000, + "temperature": 0, + "transcript_ids": [ + "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e", + "response": [ + { + "question": "Where are there wildfires?", + "answer": "CA, US" + }, + { + "question": "Is global warming affecting wildfires?", + "answer": "yes" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"Where are there wildfires?\",\n \"answer_format\": \"List of countries in ISO 3166-1 alpha-2 format\",\n \"answer_options\": [\n \"US\",\n \"CA\"\n ]\n },\n {\n \"question\": \"Is global warming affecting wildfires?\",\n \"answer_options\": [\n \"yes\",\n \"no\"\n ]\n }\n ],\n \"context\": \"This is an interview about wildfires.\",\n \"final_model\": \"default\",\n \"max_output_size\": 3000,\n \"temperature\": 0,\n \"transcript_ids\": [\n \"64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/question-answer", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "questions": [ + { + "question": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/question-answer \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"questions\": [\n {\n \"question\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_lemur.actionItems": { + "id": "endpoint_lemur.actionItems", + "namespace": [ + "subpackage_lemur" + ], + "description": "Use LeMUR to generate a list of action items from a transcript", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/lemur/v3/generate/action-items" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseParams" + ], + "properties": [ + { + "key": "answer_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "Bullet Points" + } + } + }, + "description": "How you want the action items to be returned. This can be any text.\nDefaults to \"Bullet Points\".\n" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_lemur:LemurActionItemsResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "answer_format": "Bullet Points", + "context": "This is an interview about wildfires.", + "final_model": "default", + "max_output_size": 3000, + "temperature": 0, + "transcript_ids": [ + "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e", + "response": "Here are some potential action items based on the transcript:\n\n- Monitor air quality levels in affected areas and issue warnings as needed.\n\n- Advise vulnerable populations like children, the elderly, and those with respiratory conditions to limit time outdoors.\n\n- Have schools cancel outdoor activities when air quality is poor.\n\n- Educate the public on health impacts of smoke inhalation and precautions to take.\n\n- Track progression of smoke plumes using weather and air quality monitoring systems.\n\n- Coordinate cross-regionally to manage smoke exposure as air masses shift.\n\n- Plan for likely increase in such events due to climate change. Expand monitoring and forecasting capabilities.\n\n- Conduct research to better understand health impacts of wildfire smoke and mitigation strategies.\n\n- Develop strategies to prevent and manage wildfires to limit air quality impacts.\n" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"answer_format\": \"Bullet Points\",\n \"context\": \"This is an interview about wildfires.\",\n \"final_model\": \"default\",\n \"max_output_size\": 3000,\n \"temperature\": 0,\n \"transcript_ids\": [\n \"64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/generate/action-items", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/lemur/v3/generate/action-items \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_lemur.purgeRequestData": { + "id": "endpoint_lemur.purgeRequestData", + "namespace": [ + "subpackage_lemur" + ], + "description": "Delete the data for a previously submitted LeMUR request.\nThe LLM response data, as well as any context provided in the original request will be removed.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/lemur/v3/" + }, + { + "type": "pathParameter", + "value": "request_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "pathParameters": [ + { + "key": "request_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the LeMUR request whose data you want to delete. This would be found in the response of the original request." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_lemur:PurgeLemurRequestDataResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/lemur/v3/request_id", + "responseStatusCode": 200, + "pathParameters": { + "request_id": "request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "request_id": "914fe7e4-f10a-4364-8946-34614c2873f6", + "request_id_to_purge": "b7eb03ec-1650-4181-949b-75d9de317de1", + "deleted": true + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/:request_id", + "responseStatusCode": 400, + "pathParameters": { + "request_id": ":request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/:request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/:request_id", + "responseStatusCode": 401, + "pathParameters": { + "request_id": ":request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/:request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/:request_id", + "responseStatusCode": 404, + "pathParameters": { + "request_id": ":request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/:request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/:request_id", + "responseStatusCode": 429, + "pathParameters": { + "request_id": ":request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/:request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/:request_id", + "responseStatusCode": 500, + "pathParameters": { + "request_id": ":request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/:request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/:request_id", + "responseStatusCode": 503, + "pathParameters": { + "request_id": ":request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/:request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/lemur/v3/:request_id", + "responseStatusCode": 504, + "pathParameters": { + "request_id": ":request_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.assemblyai.com/lemur/v3/:request_id \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_realtime.createTemporaryToken": { + "id": "endpoint_realtime.createTemporaryToken", + "namespace": [ + "subpackage_streaming" + ], + "description": "Create a temporary authentication token for Streaming Speech-to-Text", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v2/realtime/token" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.assemblyai.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "expires_in", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 60 + } + }, + "description": "The amount of time until the token expires in seconds" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_realtime:RealtimeTemporaryTokenResponse" + } + } + }, + "errors": [ + { + "description": "Bad request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Not found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Too many requests", + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "An error occurred while processing the request", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + }, + "examples": [] + }, + { + "description": "Service unavailable", + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + }, + { + "description": "Gateway timeout", + "statusCode": 504, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v2/realtime/token", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 480 + } + }, + "responseBody": { + "type": "json", + "value": { + "token": "fe4145dd1e7a2e149488dcd2d553a8018a89833fc5084837d66fd1bcf5a105d4" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 480\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/realtime/token", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/realtime/token", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/realtime/token", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/realtime/token", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/realtime/token", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "status": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/realtime/token", + "responseStatusCode": 503, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 0 + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/v2/realtime/token", + "responseStatusCode": 504, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "expires_in": 0 + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.assemblyai.com/v2/realtime/token \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"expires_in\": 0\n}'", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": { + "subpackage_streaming.streaming": { + "id": "subpackage_streaming.streaming", + "namespace": [ + "subpackage_streaming" + ], + "path": [ + { + "type": "literal", + "value": "/v2/realtime/ws" + } + ], + "messages": [ + { + "type": "subscribe", + "origin": "server", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_streaming:receiveMessage" + } + } + }, + { + "type": "publish", + "origin": "client", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_streaming:sendMessage" + } + } + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "wss://api.assemblyai.com" + } + ], + "queryParameters": [ + { + "key": "sample_rate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The sample rate of the streamed audio" + }, + { + "key": "word_boost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Add up to 2500 characters of custom vocabulary.\nThe parameter value must be a JSON encoded array of strings." + }, + { + "key": "encoding", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_streaming:Streaming" + } + }, + "description": "The encoding of the audio data" + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Authenticate using a [generated temporary token](https://www.assemblyai.com/docs/speech-to-text/streaming#authenticate-with-a-temporary-token)" + }, + { + "key": "disable_partial_transcripts", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Set to true to not receive partial transcripts. Defaults to false." + }, + { + "key": "enable_extra_session_information", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Set to true to receive the SessionInformation message before the session ends. Defaults to false." + } + ], + "requestHeaders": [ + { + "key": "Authentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "examples": [ + { + "path": "/v2/realtime/ws", + "pathParameters": {}, + "queryParameters": {}, + "requestHeaders": {}, + "messages": [ + { + "type": "publish", + "body": "UklGRtjIAABXQVZFZ" + }, + { + "type": "subscribe", + "body": { + "audio_start": 0, + "audio_end": 1500, + "confidence": 0.987190506414702, + "text": "there is a house in new orleans", + "words": [ + { + "start": 0, + "end": 300, + "confidence": 1, + "text": "there" + } + ], + "created": "2023-05-24T08:09:10Z", + "message_type": "PartialTranscript" + } + }, + { + "type": "subscribe", + "body": { + "audio_start": 0, + "audio_end": 1500, + "confidence": 0.987190506414702, + "text": "there is a house in new orleans", + "words": [ + { + "start": 0, + "end": 300, + "confidence": 1, + "text": "there" + } + ], + "created": "2023-05-24T08:09:10Z", + "message_type": "FinalTranscript", + "punctuated": true, + "text_formatted": true + } + }, + { + "type": "publish", + "body": { + "terminate_session": true + } + }, + { + "type": "subscribe", + "body": { + "message_type": "SessionTerminated" + } + } + ] + } + ] + } + }, + "webhooks": {}, + "types": { + "type_files:UploadedFile": { + "name": "UploadedFile", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "upload_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A URL that points to your audio file, accessible only by AssemblyAI's servers" + } + ] + } + }, + "type_transcripts:TranscriptReadyNotification": { + "name": "TranscriptReadyNotification", + "description": "The notification when the transcript status is completed or error.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "transcript_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the transcript" + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_transcripts:TranscriptReadyStatus" + }, + "description": "The status of the transcript. Either completed or error." + } + ] + } + }, + "type_transcripts:RedactedAudioResponse": { + "name": "RedactedAudioResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_transcripts:RedactedAudioStatus" + }, + "description": "The status of the redacted audio" + }, + { + "key": "redacted_audio_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL of the redacted audio file" + } + ] + } + }, + "type_transcripts:RedactedAudioStatus": { + "name": "RedactedAudioStatus", + "description": "The status of the redacted audio", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "redacted_audio_ready" + } + } + } + }, + "type_transcripts:SubtitleFormat": { + "name": "SubtitleFormat", + "description": "Format of the subtitles", + "shape": { + "type": "enum", + "values": [ + { + "value": "srt" + }, + { + "value": "vtt" + } + ] + } + }, + "type_transcripts:WordSearchResponse": { + "name": "WordSearchResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the transcript" + }, + { + "key": "total_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total count of all matched instances. For e.g., word 1 matched 2 times, and word 2 matched 3 times, `total_count` will equal 5." + }, + { + "key": "matches", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:WordSearchMatch" + } + }, + "description": "The matches of the search" + } + ] + } + }, + "type_transcripts:WordSearchMatch": { + "name": "WordSearchMatch", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The matched word" + }, + { + "key": "count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total amount of times the word is in the transcript" + }, + { + "key": "timestamps", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:WordSearchTimestamp" + } + }, + "description": "An array of timestamps" + }, + { + "key": "indexes", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "An array of all index locations for that word within the `words` array of the completed transcript" + } + ] + } + }, + "type_transcripts:WordSearchTimestamp": { + "name": "WordSearchTimestamp", + "description": "An array of timestamps structured as [`start_time`, `end_time`] in milliseconds", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "type_transcripts:Timestamp": { + "name": "Timestamp", + "description": "Timestamp containing a start and end property in milliseconds", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The start time in milliseconds" + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The end time in milliseconds" + } + ] + } + }, + "type_transcripts:TranscriptOptionalParams": { + "name": "TranscriptOptionalParams", + "description": "The parameters for creating a transcript", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "language_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:TranscriptLanguageCode" + } + } + }, + { + "key": "punctuate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable Automatic Punctuation, can be true or false" + }, + { + "key": "format_text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable Text Formatting, can be true or false" + }, + { + "key": "dual_channel", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false." + }, + { + "key": "speech_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:SpeechModel" + } + } + }, + { + "key": "webhook_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL to which AssemblyAI send webhooks upon transcription completion" + }, + { + "key": "webhook_auth_header_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The header name which should be sent back with webhook calls" + }, + { + "key": "webhook_auth_header_value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Specify a header name and value to send back with a webhook call for added security" + }, + { + "key": "auto_highlights", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable Key Phrases, either true or false" + }, + { + "key": "audio_start_from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The point in time, in milliseconds, to begin transcribing in your media file" + }, + { + "key": "audio_end_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The point in time, in milliseconds, to stop transcribing in your media file" + }, + { + "key": "word_boost", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of custom vocabulary to boost transcription probability for" + }, + { + "key": "boost_param", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:TranscriptBoostParam" + } + }, + "description": "The word boost parameter value" + }, + { + "key": "filter_profanity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Filter profanity from the transcribed text, can be true or false" + }, + { + "key": "redact_pii", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Redact PII from the transcribed text using the Redact PII model, can be true or false" + }, + { + "key": "redact_pii_audio", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Generate a copy of the original media file with spoken PII \"beeped\" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details." + }, + { + "key": "redact_pii_audio_quality", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:RedactPiiAudioQuality" + } + }, + "description": "Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details." + }, + { + "key": "redact_pii_policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:PiiPolicy" + } + } + }, + "description": "The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details." + }, + { + "key": "redact_pii_sub", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:SubstitutionPolicy" + } + } + }, + { + "key": "speaker_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false" + }, + { + "key": "speakers_expected", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Tells the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details." + }, + { + "key": "content_safety", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false" + }, + { + "key": "content_safety_confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The confidence threshold for the Content Moderation model. Values must be between 25 and 100." + }, + { + "key": "iab_categories", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false" + }, + { + "key": "language_detection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection), either true or false." + }, + { + "key": "custom_spelling", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptCustomSpelling" + } + } + }, + "description": "Customize how words are spelled and formatted using to and from values" + }, + { + "key": "disfluencies", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Transcribe Filler Words, like \"umm\", in your media file; can be true or false" + }, + { + "key": "sentiment_analysis", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be true or false" + }, + { + "key": "auto_chapters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can be true or false" + }, + { + "key": "entity_detection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection), can be true or false" + }, + { + "key": "speech_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive." + }, + { + "key": "summarization", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false" + }, + { + "key": "summary_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:SummaryModel" + } + }, + "description": "The model to summarize the transcript" + }, + { + "key": "summary_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:SummaryType" + } + }, + "description": "The type of summary" + }, + { + "key": "custom_topics", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Enable custom topics, either true or false" + }, + { + "key": "topics", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of custom topics" + } + ] + } + }, + "type_transcripts:SummaryModel": { + "name": "SummaryModel", + "description": "The model to summarize the transcript", + "shape": { + "type": "enum", + "values": [ + { + "value": "informative" + }, + { + "value": "conversational" + }, + { + "value": "catchy" + } + ] + } + }, + "type_transcripts:SummaryType": { + "name": "SummaryType", + "description": "The type of summary", + "shape": { + "type": "enum", + "values": [ + { + "value": "bullets" + }, + { + "value": "bullets_verbose" + }, + { + "value": "gist" + }, + { + "value": "headline" + }, + { + "value": "paragraph" + } + ] + } + }, + "type_transcripts:TranscriptBoostParam": { + "name": "TranscriptBoostParam", + "description": "The word boost parameter value", + "shape": { + "type": "enum", + "values": [ + { + "value": "low" + }, + { + "value": "default" + }, + { + "value": "high" + } + ] + } + }, + "type_transcripts:TranscriptCustomSpelling": { + "name": "TranscriptCustomSpelling", + "description": "Object containing words or phrases to replace, and the word or phrase to replace with", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Words or phrases to replace" + }, + { + "key": "to", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Word or phrase to replace with" + } + ] + } + }, + "type_transcripts:TranscriptUtterance": { + "name": "TranscriptUtterance", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + }, + "description": "The confidence score for the transcript of this utterance" + }, + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The starting time, in milliseconds, of the utterance in the audio file" + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The ending time, in milliseconds, of the utterance in the audio file" + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The text for this utterance" + }, + { + "key": "words", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptWord" + } + }, + "description": "The words in the utterance." + }, + { + "key": "speaker", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. \"A\" for Speaker A, \"B\" for Speaker B, etc." + } + ] + } + }, + "type_transcripts:SubstitutionPolicy": { + "name": "SubstitutionPolicy", + "description": "The replacement logic for detected PII, can be \"entity_name\" or \"hash\". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.", + "shape": { + "type": "enum", + "values": [ + { + "value": "entity_name" + }, + { + "value": "hash" + } + ] + } + }, + "type_transcripts:RedactPiiAudioQuality": { + "name": "RedactPiiAudioQuality", + "description": "Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.", + "shape": { + "type": "enum", + "values": [ + { + "description": "MP3 audio format is lower quality and lower size than WAV.", + "value": "mp3" + }, + { + "description": "WAV audio format is the highest quality (no compression) and larger size than MP3.", + "value": "wav" + } + ] + } + }, + "type_transcripts:PiiPolicy": { + "name": "PiiPolicy", + "description": "The type of PII to redact", + "shape": { + "type": "enum", + "values": [ + { + "description": "Customer account or membership identification number (e.g., Policy No. 10042992, Member ID: HZ-5235-001)", + "value": "account_number" + }, + { + "description": "Banking information, including account and routing numbers", + "value": "banking_information" + }, + { + "description": "Blood type (e.g., O-, AB positive)", + "value": "blood_type" + }, + { + "description": "Credit card verification code (e.g., CVV: 080)", + "value": "credit_card_cvv" + }, + { + "description": "Expiration date of a credit card", + "value": "credit_card_expiration" + }, + { + "description": "Credit card number", + "value": "credit_card_number" + }, + { + "description": "Specific calendar date (e.g., December 18)", + "value": "date" + }, + { + "description": "Broader time periods, including date ranges, months, seasons, years, and decades (e.g., 2020-2021, 5-9 May, January 1984)", + "value": "date_interval" + }, + { + "description": "Date of birth (e.g., Date of Birth: March 7,1961)", + "value": "date_of_birth" + }, + { + "description": "Driver's license number. (e.g., DL# 356933-540)", + "value": "drivers_license" + }, + { + "description": "Medications, vitamins, or supplements (e.g., Advil, Acetaminophen, Panadol)", + "value": "drug" + }, + { + "description": "Periods of time, specified as a number and a unit of time (e.g., 8 months, 2 years)", + "value": "duration" + }, + { + "description": "Email address (e.g., support@assemblyai.com)", + "value": "email_address" + }, + { + "description": "Name of an event or holiday (e.g., Olympics, Yom Kippur)", + "value": "event" + }, + { + "description": "Names of computer files, including the extension or filepath (e.g., Taxes/2012/brad-tax-returns.pdf)", + "value": "filename" + }, + { + "description": "Terms indicating gender identity or sexual orientation, including slang terms (e.g., female, bisexual, trans)", + "value": "gender_sexuality" + }, + { + "description": "Healthcare numbers and health plan beneficiary numbers (e.g., Policy No.: 5584-486-674-YM)", + "value": "healthcare_number" + }, + { + "description": "Bodily injury (e.g., I broke my arm, I have a sprained wrist)", + "value": "injury" + }, + { + "description": "Internet IP address, including IPv4 and IPv6 formats (e.g., 192.168.0.1)", + "value": "ip_address" + }, + { + "description": "Name of a natural language (e.g., Spanish, French)", + "value": "language" + }, + { + "description": "Any Location reference including mailing address, postal code, city, state, province, country, or coordinates. (e.g., Lake Victoria, 145 Windsor St., 90210)", + "value": "location" + }, + { + "description": "Terms indicating marital status (e.g., Single, common-law, ex-wife, married)", + "value": "marital_status" + }, + { + "description": "Name of a medical condition, disease, syndrome, deficit, or disorder (e.g., chronic fatigue syndrome, arrhythmia, depression)", + "value": "medical_condition" + }, + { + "description": "Medical process, including treatments, procedures, and tests (e.g., heart surgery, CT scan)", + "value": "medical_process" + }, + { + "description": "Name and/or amount of currency (e.g., 15 pesos, $94.50)", + "value": "money_amount" + }, + { + "description": "Terms indicating nationality, ethnicity, or race (e.g., American, Asian, Caucasian)", + "value": "nationality" + }, + { + "description": "Numerical PII (including alphanumeric strings) that doesn't fall under other categories", + "value": "number_sequence" + }, + { + "description": "Job title or profession (e.g., professor, actors, engineer, CPA)", + "value": "occupation" + }, + { + "description": "Name of an organization (e.g., CNN, McDonalds, University of Alaska, Northwest General Hospital)", + "value": "organization" + }, + { + "description": "Passport numbers, issued by any country (e.g., PA4568332, NU3C6L86S12)", + "value": "passport_number" + }, + { + "description": "Account passwords, PINs, access keys, or verification answers (e.g., 27%alfalfa, temp1234, My mother's maiden name is Smith)", + "value": "password" + }, + { + "description": "Number associated with an age (e.g., 27, 75)", + "value": "person_age" + }, + { + "description": "Name of a person (e.g., Bob, Doug Jones, Dr. Kay Martinez, MD)", + "value": "person_name" + }, + { + "description": "Telephone or fax number", + "value": "phone_number" + }, + { + "description": "Distinctive bodily attributes, including terms indicating race (e.g., I'm 190cm tall, He belongs to the Black students' association)", + "value": "physical_attribute" + }, + { + "description": "Terms referring to a political party, movement, or ideology (e.g., Republican, Liberal)", + "value": "political_affiliation" + }, + { + "description": "Terms indicating religious affiliation (e.g., Hindu, Catholic)", + "value": "religion" + }, + { + "description": "Medical statistics (e.g., 18%, 18 percent)", + "value": "statistics" + }, + { + "description": "Expressions indicating clock times (e.g., 19:37:28, 10pm EST)", + "value": "time" + }, + { + "description": "Internet addresses (e.g., https://www.assemblyai.com/)", + "value": "url" + }, + { + "description": "Social Security Number or equivalent", + "value": "us_social_security_number" + }, + { + "description": "Usernames, login names, or handles (e.g., @AssemblyAI)", + "value": "username" + }, + { + "description": "Vehicle identification numbers (VINs), vehicle serial numbers, and license plate numbers (e.g., 5FNRL38918B111818, BIF7547)", + "value": "vehicle_id" + }, + { + "description": "Names of Zodiac signs (e.g., Aries, Taurus)", + "value": "zodiac_sign" + } + ] + } + }, + "type_transcripts:SpeechModel": { + "name": "SpeechModel", + "description": "The speech model to use for the transcription.", + "shape": { + "type": "enum", + "values": [ + { + "description": "The best model optimized for accuracy.", + "value": "best" + }, + { + "description": "A lightweight, lower cost model for a wide range of languages.", + "value": "nano" + }, + { + "description": "Deprecated: Conformer-2 is a heavy-duty model optimized for accuracy.\nThis option will stop working in the near future. Use best or nano instead.", + "value": "conformer-2" + } + ] + } + }, + "type_transcripts:TranscriptLanguageCode": { + "name": "TranscriptLanguageCode", + "description": "The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).\nThe default value is 'en_us'.", + "shape": { + "type": "enum", + "values": [ + { + "value": "en" + }, + { + "value": "en_au" + }, + { + "value": "en_uk" + }, + { + "value": "en_us" + }, + { + "value": "es" + }, + { + "value": "fr" + }, + { + "value": "de" + }, + { + "value": "it" + }, + { + "value": "pt" + }, + { + "value": "nl" + }, + { + "value": "af" + }, + { + "value": "sq" + }, + { + "value": "am" + }, + { + "value": "ar" + }, + { + "value": "hy" + }, + { + "value": "as" + }, + { + "value": "az" + }, + { + "value": "ba" + }, + { + "value": "eu" + }, + { + "value": "be" + }, + { + "value": "bn" + }, + { + "value": "bs" + }, + { + "value": "br" + }, + { + "value": "bg" + }, + { + "value": "my" + }, + { + "value": "ca" + }, + { + "value": "zh" + }, + { + "value": "hr" + }, + { + "value": "cs" + }, + { + "value": "da" + }, + { + "value": "et" + }, + { + "value": "fo" + }, + { + "value": "fi" + }, + { + "value": "gl" + }, + { + "value": "ka" + }, + { + "value": "el" + }, + { + "value": "gu" + }, + { + "value": "ht" + }, + { + "value": "ha" + }, + { + "value": "haw" + }, + { + "value": "he" + }, + { + "value": "hi" + }, + { + "value": "hu" + }, + { + "value": "is" + }, + { + "value": "id" + }, + { + "value": "ja" + }, + { + "value": "jw" + }, + { + "value": "kn" + }, + { + "value": "kk" + }, + { + "value": "km" + }, + { + "value": "ko" + }, + { + "value": "lo" + }, + { + "value": "la" + }, + { + "value": "lv" + }, + { + "value": "ln" + }, + { + "value": "lt" + }, + { + "value": "lb" + }, + { + "value": "mk" + }, + { + "value": "mg" + }, + { + "value": "ms" + }, + { + "value": "ml" + }, + { + "value": "mt" + }, + { + "value": "mi" + }, + { + "value": "mr" + }, + { + "value": "mn" + }, + { + "value": "ne" + }, + { + "value": "no" + }, + { + "value": "nn" + }, + { + "value": "oc" + }, + { + "value": "pa" + }, + { + "value": "ps" + }, + { + "value": "fa" + }, + { + "value": "pl" + }, + { + "value": "ro" + }, + { + "value": "ru" + }, + { + "value": "sa" + }, + { + "value": "sr" + }, + { + "value": "sn" + }, + { + "value": "sd" + }, + { + "value": "si" + }, + { + "value": "sk" + }, + { + "value": "sl" + }, + { + "value": "so" + }, + { + "value": "su" + }, + { + "value": "sw" + }, + { + "value": "sv" + }, + { + "value": "tl" + }, + { + "value": "tg" + }, + { + "value": "ta" + }, + { + "value": "tt" + }, + { + "value": "te" + }, + { + "value": "th" + }, + { + "value": "bo" + }, + { + "value": "tr" + }, + { + "value": "tk" + }, + { + "value": "uk" + }, + { + "value": "ur" + }, + { + "value": "uz" + }, + { + "value": "vi" + }, + { + "value": "cy" + }, + { + "value": "yi" + }, + { + "value": "yo" + } + ] + } + }, + "type_transcripts:TranscriptStatus": { + "name": "TranscriptStatus", + "description": "The status of your transcript. Possible values are queued, processing, completed, or error.", + "shape": { + "type": "enum", + "values": [ + { + "description": "The audio file is in the queue to be processed by the API.", + "value": "queued" + }, + { + "description": "The audio file is being processed by the API.", + "value": "processing" + }, + { + "description": "The transcript job has been completed successfully.", + "value": "completed" + }, + { + "description": "An error occurred while processing the audio file.", + "value": "error" + } + ] + } + }, + "type_transcripts:TranscriptReadyStatus": { + "name": "TranscriptReadyStatus", + "description": "The status of the transcript. Either completed or error.", + "shape": { + "type": "enum", + "values": [ + { + "description": "The transcript job has been completed successfully.", + "value": "completed" + }, + { + "description": "An error occurred while processing the audio file.", + "value": "error" + } + ] + } + }, + "type_transcripts:Transcript": { + "name": "Transcript", + "description": "A transcript object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique identifier of your transcript" + }, + { + "key": "language_model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The language model that was used for the transcript" + }, + { + "key": "acoustic_model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The acoustic model that was used for the transcript" + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_transcripts:TranscriptStatus" + }, + "description": "The status of your transcript. Possible values are queued, processing, completed, or error." + }, + { + "key": "language_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:TranscriptLanguageCode" + } + }, + "description": "The language of your audio file.\nPossible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).\nThe default value is 'en_us'." + }, + { + "key": "audio_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL of the media that was transcribed" + }, + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The textual transcript of your media file" + }, + { + "key": "words", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptWord" + } + } + }, + "description": "An array of temporally-sequential word objects, one for each word in the transcript.\nSee [Speech recognition](https://www.assemblyai.com/docs/models/speech-recognition) for more information." + }, + { + "key": "utterances", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptUtterance" + } + } + }, + "description": "When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterance objects.\nSee [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more information." + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + "description": "The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)" + }, + { + "key": "audio_duration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The duration of this transcript object's media file, in seconds" + }, + { + "key": "punctuate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether Automatic Punctuation is enabled, either true or false" + }, + { + "key": "format_text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether Text Formatting is enabled, either true or false" + }, + { + "key": "dual_channel", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Dual channel transcription](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) was enabled in the transcription request, either true or false" + }, + { + "key": "speech_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:SpeechModel" + } + } + }, + { + "key": "webhook_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL to which we send webhooks upon transcription completion" + }, + { + "key": "webhook_status_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The status code we received from your server when delivering your webhook, if a webhook URL was provided" + }, + { + "key": "webhook_auth", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether webhook authentication details were provided" + }, + { + "key": "webhook_auth_header_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The header name which should be sent back with webhook calls" + }, + { + "key": "speed_boost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether speed boost is enabled" + }, + { + "key": "auto_highlights", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether Key Phrases is enabled, either true or false" + }, + { + "key": "auto_highlights_result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:AutoHighlightsResult" + } + } + }, + { + "key": "audio_start_from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The point in time, in milliseconds, in the file at which the transcription was started" + }, + { + "key": "audio_end_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The point in time, in milliseconds, in the file at which the transcription was terminated" + }, + { + "key": "word_boost", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of custom vocabulary to boost transcription probability for" + }, + { + "key": "boost_param", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The word boost parameter value" + }, + { + "key": "filter_profanity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Profanity Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) is enabled, either true or false" + }, + { + "key": "redact_pii", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether [PII Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is enabled, either true or false" + }, + { + "key": "redact_pii_audio", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether a redacted version of the audio file was generated,\neither true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information." + }, + { + "key": "redact_pii_audio_quality", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:RedactPiiAudioQuality" + } + } + }, + { + "key": "redact_pii_policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:PiiPolicy" + } + } + }, + "description": "The list of PII Redaction policies that were enabled, if PII Redaction is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information." + }, + { + "key": "redact_pii_sub", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:SubstitutionPolicy" + } + }, + "description": "The replacement logic for detected PII, can be \"entity_type\" or \"hash\". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details." + }, + { + "key": "speaker_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, can be true or false" + }, + { + "key": "speakers_expected", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Tell the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details." + }, + { + "key": "content_safety", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation) is enabled, can be true or false" + }, + { + "key": "content_safety_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:ContentSafetyLabelsResult" + } + } + }, + { + "key": "iab_categories", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) is enabled, can be true or false" + }, + { + "key": "iab_categories_result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:TopicDetectionModelResult" + } + } + }, + { + "key": "language_detection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) is enabled, either true or false" + }, + { + "key": "custom_spelling", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptCustomSpelling" + } + } + }, + "description": "Customize how words are spelled and formatted using to and from values" + }, + { + "key": "auto_chapters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false" + }, + { + "key": "chapters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:Chapter" + } + } + }, + "description": "An array of temporally sequential chapters for the audio file" + }, + { + "key": "summarization", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled, either true or false" + }, + { + "key": "summary_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled" + }, + { + "key": "summary_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Summarization model used to generate the summary,\nif [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled" + }, + { + "key": "summary", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The generated summary of the media file, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled" + }, + { + "key": "custom_topics", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether custom topics is enabled, either true or false" + }, + { + "key": "topics", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of custom topics provided if custom topics is enabled" + }, + { + "key": "disfluencies", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Transcribe Filler Words, like \"umm\", in your media file; can be true or false" + }, + { + "key": "sentiment_analysis", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) is enabled, can be true or false" + }, + { + "key": "sentiment_analysis_results", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:SentimentAnalysisResult" + } + } + }, + "description": "An array of results for the Sentiment Analysis model, if it is enabled.\nSee [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) for more information." + }, + { + "key": "entity_detection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection) is enabled, can be true or false" + }, + { + "key": "entities", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:Entity" + } + } + }, + "description": "An array of results for the Entity Detection model, if it is enabled.\nSee [Entity detection](https://www.assemblyai.com/docs/models/entity-detection) for more information." + }, + { + "key": "speech_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Defaults to null. Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive." + }, + { + "key": "throttled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "True while a request is throttled and false when a request is no longer throttled" + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message of why the transcript failed" + } + ] + } + }, + "type_transcripts:TopicDetectionModelResult": { + "name": "TopicDetectionModelResult", + "description": "The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_transcripts:AudioIntelligenceModelStatus" + }, + "description": "The status of the Topic Detection model. Either success, or unavailable in the rare case that the model failed." + }, + { + "key": "results", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TopicDetectionResult" + } + }, + "description": "An array of results for the Topic Detection model" + }, + { + "key": "summary", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The overall relevance of topic to the entire audio file" + } + ] + } + }, + "type_transcripts:ContentSafetyLabelsResult": { + "name": "ContentSafetyLabelsResult", + "description": "An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_transcripts:AudioIntelligenceModelStatus" + }, + "description": "The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed." + }, + { + "key": "results", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:ContentSafetyLabelResult" + } + } + }, + { + "key": "summary", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "A summary of the Content Moderation confidence results for the entire audio file" + }, + { + "key": "severity_score_summary", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_transcripts:SeverityScoreSummary" + } + }, + "description": "A summary of the Content Moderation severity results for the entire audio file" + } + ] + } + }, + "type_transcripts:Chapter": { + "name": "Chapter", + "description": "Chapter of the audio file", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gist", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An ultra-short summary (just a few words) of the content spoken in the chapter" + }, + { + "key": "headline", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A single sentence summary of the content spoken during the chapter" + }, + { + "key": "summary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A one paragraph summary of the content spoken during the chapter" + }, + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The starting time, in milliseconds, for the chapter" + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The starting time, in milliseconds, for the chapter" + } + ] + } + }, + "type_transcripts:Entity": { + "name": "Entity", + "description": "A detected entity", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "entity_type", + "valueShape": { + "type": "id", + "id": "type_transcripts:EntityType" + }, + "description": "The type of entity for the detected entity" + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The text for the detected entity" + }, + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The starting time, in milliseconds, at which the detected entity appears in the audio file" + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The ending time, in milliseconds, for the detected entity in the audio file" + } + ] + } + }, + "type_transcripts:EntityType": { + "name": "EntityType", + "description": "The type of entity for the detected entity", + "shape": { + "type": "enum", + "values": [ + { + "description": "Customer account or membership identification number (e.g., Policy No. 10042992, Member ID: HZ-5235-001)", + "value": "account_number" + }, + { + "description": "Banking information, including account and routing numbers", + "value": "banking_information" + }, + { + "description": "Blood type (e.g., O-, AB positive)", + "value": "blood_type" + }, + { + "description": "Credit card verification code (e.g., CVV: 080)", + "value": "credit_card_cvv" + }, + { + "description": "Expiration date of a credit card", + "value": "credit_card_expiration" + }, + { + "description": "Credit card number", + "value": "credit_card_number" + }, + { + "description": "Specific calendar date (e.g., December 18)", + "value": "date" + }, + { + "description": "Broader time periods, including date ranges, months, seasons, years, and decades (e.g., 2020-2021, 5-9 May, January 1984)", + "value": "date_interval" + }, + { + "description": "Date of birth (e.g., Date of Birth: March 7,1961)", + "value": "date_of_birth" + }, + { + "description": "Driver's license number. (e.g., DL# 356933-540)", + "value": "drivers_license" + }, + { + "description": "Medications, vitamins, or supplements (e.g., Advil, Acetaminophen, Panadol)", + "value": "drug" + }, + { + "description": "Periods of time, specified as a number and a unit of time (e.g., 8 months, 2 years)", + "value": "duration" + }, + { + "description": "Email address (e.g., support@assemblyai.com)", + "value": "email_address" + }, + { + "description": "Name of an event or holiday (e.g., Olympics, Yom Kippur)", + "value": "event" + }, + { + "description": "Names of computer files, including the extension or filepath (e.g., Taxes/2012/brad-tax-returns.pdf)", + "value": "filename" + }, + { + "description": "Terms indicating gender identity or sexual orientation, including slang terms (e.g., female, bisexual, trans)", + "value": "gender_sexuality" + }, + { + "description": "Healthcare numbers and health plan beneficiary numbers (e.g., Policy No.: 5584-486-674-YM)", + "value": "healthcare_number" + }, + { + "description": "Bodily injury (e.g., I broke my arm, I have a sprained wrist)", + "value": "injury" + }, + { + "description": "Internet IP address, including IPv4 and IPv6 formats (e.g., 192.168.0.1)", + "value": "ip_address" + }, + { + "description": "Name of a natural language (e.g., Spanish, French)", + "value": "language" + }, + { + "description": "Any Location reference including mailing address, postal code, city, state, province, country, or coordinates. (e.g., Lake Victoria, 145 Windsor St., 90210)", + "value": "location" + }, + { + "description": "Terms indicating marital status (e.g., Single, common-law, ex-wife, married)", + "value": "marital_status" + }, + { + "description": "Name of a medical condition, disease, syndrome, deficit, or disorder (e.g., chronic fatigue syndrome, arrhythmia, depression)", + "value": "medical_condition" + }, + { + "description": "Medical process, including treatments, procedures, and tests (e.g., heart surgery, CT scan)", + "value": "medical_process" + }, + { + "description": "Name and/or amount of currency (e.g., 15 pesos, $94.50)", + "value": "money_amount" + }, + { + "description": "Terms indicating nationality, ethnicity, or race (e.g., American, Asian, Caucasian)", + "value": "nationality" + }, + { + "description": "Numerical PII (including alphanumeric strings) that doesn't fall under other categories", + "value": "number_sequence" + }, + { + "description": "Job title or profession (e.g., professor, actors, engineer, CPA)", + "value": "occupation" + }, + { + "description": "Name of an organization (e.g., CNN, McDonalds, University of Alaska, Northwest General Hospital)", + "value": "organization" + }, + { + "description": "Passport numbers, issued by any country (e.g., PA4568332, NU3C6L86S12)", + "value": "passport_number" + }, + { + "description": "Account passwords, PINs, access keys, or verification answers (e.g., 27%alfalfa, temp1234, My mother's maiden name is Smith)", + "value": "password" + }, + { + "description": "Number associated with an age (e.g., 27, 75)", + "value": "person_age" + }, + { + "description": "Name of a person (e.g., Bob, Doug Jones, Dr. Kay Martinez, MD)", + "value": "person_name" + }, + { + "description": "Telephone or fax number", + "value": "phone_number" + }, + { + "description": "Distinctive bodily attributes, including terms indicating race (e.g., I'm 190cm tall, He belongs to the Black students' association)", + "value": "physical_attribute" + }, + { + "description": "Terms referring to a political party, movement, or ideology (e.g., Republican, Liberal)", + "value": "political_affiliation" + }, + { + "description": "Terms indicating religious affiliation (e.g., Hindu, Catholic)", + "value": "religion" + }, + { + "description": "Medical statistics (e.g., 18%, 18 percent)", + "value": "statistics" + }, + { + "description": "Expressions indicating clock times (e.g., 19:37:28, 10pm EST)", + "value": "time" + }, + { + "description": "Internet addresses (e.g., https://www.assemblyai.com/)", + "value": "url" + }, + { + "description": "Social Security Number or equivalent", + "value": "us_social_security_number" + }, + { + "description": "Usernames, login names, or handles (e.g., @AssemblyAI)", + "value": "username" + }, + { + "description": "Vehicle identification numbers (VINs), vehicle serial numbers, and license plate numbers (e.g., 5FNRL38918B111818, BIF7547)", + "value": "vehicle_id" + }, + { + "description": "Names of Zodiac signs (e.g., Aries, Taurus)", + "value": "zodiac_sign" + } + ] + } + }, + "type_transcripts:SentimentAnalysisResult": { + "name": "SentimentAnalysisResult", + "description": "The result of the Sentiment Analysis model", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The transcript of the sentence" + }, + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The starting time, in milliseconds, of the sentence" + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The ending time, in milliseconds, of the sentence" + }, + { + "key": "sentiment", + "valueShape": { + "type": "id", + "id": "type_transcripts:Sentiment" + }, + "description": "The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE" + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + }, + "description": "The confidence score for the detected sentiment of the sentence, from 0 to 1" + }, + { + "key": "speaker", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null" + } + ] + } + }, + "type_transcripts:Sentiment": { + "name": "Sentiment", + "shape": { + "type": "enum", + "values": [ + { + "value": "POSITIVE" + }, + { + "value": "NEUTRAL" + }, + { + "value": "NEGATIVE" + } + ] + } + }, + "type_transcripts:TopicDetectionResultLabelsItem": { + "name": "TopicDetectionResultLabelsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "relevance", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + }, + "description": "How relevant the detected topic is of a detected topic" + }, + { + "key": "label", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship" + } + ] + } + }, + "type_transcripts:TopicDetectionResult": { + "name": "TopicDetectionResult", + "description": "The result of the topic detection model", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The text in the transcript in which a detected topic occurs" + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TopicDetectionResultLabelsItem" + } + } + } + }, + { + "key": "timestamp", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_transcripts:Timestamp" + } + } + } + ] + } + }, + "type_transcripts:ContentSafetyLabel": { + "name": "ContentSafetyLabel", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "label", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The label of the sensitive topic" + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + }, + "description": "The confidence score for the topic being discussed, from 0 to 1" + }, + { + "key": "severity", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + }, + "description": "How severely the topic is discussed in the section, from 0 to 1" + } + ] + } + }, + "type_transcripts:ContentSafetyLabelResult": { + "name": "ContentSafetyLabelResult", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The transcript of the section flagged by the Content Moderation model" + }, + { + "key": "labels", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:ContentSafetyLabel" + } + }, + "description": "An array of safety labels, one per sensitive topic that was detected in the section" + }, + { + "key": "sentences_idx_start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The sentence index at which the section begins" + }, + { + "key": "sentences_idx_end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The sentence index at which the section ends" + }, + { + "key": "timestamp", + "valueShape": { + "type": "id", + "id": "type_transcripts:Timestamp" + }, + "description": "Timestamp information for the section" + } + ] + } + }, + "type_transcripts:SeverityScoreSummary": { + "name": "SeverityScoreSummary", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "low", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + { + "key": "medium", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + { + "key": "high", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + } + ] + } + }, + "type_transcripts:AutoHighlightsResult": { + "name": "AutoHighlightsResult", + "description": "An array of results for the Key Phrases model, if it is enabled.\nSee [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_transcripts:AudioIntelligenceModelStatus" + }, + "description": "The status of the Key Phrases model. Either success, or unavailable in the rare case that the model failed." + }, + { + "key": "results", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:AutoHighlightResult" + } + }, + "description": "A temporally-sequential array of Key Phrases" + } + ] + } + }, + "type_transcripts:AutoHighlightResult": { + "name": "AutoHighlightResult", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of times the key phrase appears in the audio file" + }, + { + "key": "rank", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The total relevancy to the overall audio file of this key phrase - a greater number means more relevant" + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The text itself of the key phrase" + }, + { + "key": "timestamps", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:Timestamp" + } + }, + "description": "The timestamp of the of the key phrase" + } + ] + } + }, + "type_transcripts:TranscriptWord": { + "name": "TranscriptWord", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "speaker", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null" + } + ] + } + }, + "type_transcripts:TranscriptSentence": { + "name": "TranscriptSentence", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + { + "key": "words", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptWord" + } + } + }, + { + "key": "speaker", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null" + } + ] + } + }, + "type_transcripts:SentencesResponse": { + "name": "SentencesResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + { + "key": "audio_duration", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "sentences", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptSentence" + } + } + } + ] + } + }, + "type_transcripts:TranscriptParagraph": { + "name": "TranscriptParagraph", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + { + "key": "words", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptWord" + } + } + }, + { + "key": "speaker", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null" + } + ] + } + }, + "type_transcripts:ParagraphsResponse": { + "name": "ParagraphsResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + }, + { + "key": "audio_duration", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "paragraphs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptParagraph" + } + } + } + ] + } + }, + "type_transcripts:PageDetails": { + "name": "PageDetails", + "description": "Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results this page is limited to" + }, + { + "key": "result_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The actual number of results in the page" + }, + { + "key": "current_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL used to retrieve the current page of transcripts" + }, + { + "key": "prev_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL to the next page of transcripts. The previous URL always points to a page with older transcripts." + }, + { + "key": "next_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL to the next page of transcripts. The next URL always points to a page with newer transcripts." + } + ] + } + }, + "type_transcripts:TranscriptListItem": { + "name": "TranscriptListItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "resource_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_transcripts:TranscriptStatus" + } + }, + { + "key": "created", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "completed", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "audio_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message of why the transcript failed" + } + ] + } + }, + "type_transcripts:TranscriptList": { + "name": "TranscriptList", + "description": "A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "page_details", + "valueShape": { + "type": "id", + "id": "type_transcripts:PageDetails" + } + }, + { + "key": "transcripts", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_transcripts:TranscriptListItem" + } + } + } + ] + } + }, + "type_transcripts:AudioIntelligenceModelStatus": { + "name": "AudioIntelligenceModelStatus", + "description": "Either success, or unavailable in the rare case that the model failed", + "shape": { + "type": "enum", + "values": [ + { + "value": "success" + }, + { + "value": "unavailable" + } + ] + } + }, + "type_realtime:RealtimeBaseMessage": { + "name": "RealtimeBaseMessage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "id", + "id": "type_realtime:MessageType" + }, + "description": "Describes the type of the message" + } + ] + } + }, + "type_realtime:RealtimeMessage": { + "name": "RealtimeMessage", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Session Begins", + "shape": { + "type": "id", + "id": "type_realtime:SessionBegins" + } + }, + { + "displayName": "Partial Transcript", + "shape": { + "type": "id", + "id": "type_realtime:PartialTranscript" + } + }, + { + "displayName": "Final Transcript", + "shape": { + "type": "id", + "id": "type_realtime:FinalTranscript" + } + }, + { + "displayName": "Session Information", + "shape": { + "type": "id", + "id": "type_realtime:SessionInformation" + } + }, + { + "displayName": "Session Terminated", + "shape": { + "type": "id", + "id": "type_realtime:SessionTerminated" + } + }, + { + "displayName": "Realtime Error", + "shape": { + "type": "id", + "id": "type_realtime:RealtimeError" + } + } + ] + } + }, + "type_realtime:RealtimeError": { + "name": "RealtimeError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_realtime:MessageType": { + "name": "MessageType", + "shape": { + "type": "enum", + "values": [ + { + "value": "SessionBegins" + }, + { + "value": "PartialTranscript" + }, + { + "value": "FinalTranscript" + }, + { + "value": "SessionInformation" + }, + { + "value": "SessionTerminated" + } + ] + } + }, + "type_realtime:RealtimeTranscriptType": { + "name": "RealtimeTranscriptType", + "shape": { + "type": "enum", + "values": [ + { + "value": "PartialTranscript" + }, + { + "value": "FinalTranscript" + } + ] + } + }, + "type_realtime:RealtimeTranscript": { + "name": "RealtimeTranscript", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Partial Transcript", + "shape": { + "type": "id", + "id": "type_realtime:PartialTranscript" + } + }, + { + "displayName": "Final Transcript", + "shape": { + "type": "id", + "id": "type_realtime:FinalTranscript" + } + } + ] + } + }, + "type_realtime:SessionBegins": { + "name": "SessionBegins", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "SessionBegins" + } + }, + "description": "Describes the type of the message" + }, + { + "key": "session_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the established session" + }, + { + "key": "expires_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Timestamp when this session will expire" + } + ] + } + }, + "type_realtime:SessionInformation": { + "name": "SessionInformation", + "description": "Information about the session that is concluding.\nThis message is sent at the end of the session, before the SessionTerminated message.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "SessionInformation" + } + }, + "description": "Describes the type of the message" + }, + { + "key": "audio_duration_seconds", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The total duration of the audio in seconds" + } + ] + } + }, + "type_realtime:SessionTerminated": { + "name": "SessionTerminated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "SessionTerminated" + } + }, + "description": "Describes the type of the message" + } + ] + } + }, + "type_realtime:RealtimeBaseTranscript": { + "name": "RealtimeBaseTranscript", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "audio_start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Start time of audio sample relative to session start, in milliseconds" + }, + { + "key": "audio_end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "End time of audio sample relative to session start, in milliseconds" + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + }, + "description": "The confidence score of the entire transcription, between 0 and 1" + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The partial transcript for your audio" + }, + { + "key": "words", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_realtime:Word" + } + }, + "description": "An array of objects, with the information for each word in the transcription text.\nIncludes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself." + }, + { + "key": "created", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The timestamp for the partial transcript" + } + ] + } + }, + "type_realtime:PartialTranscript": { + "name": "PartialTranscript", + "shape": { + "type": "object", + "extends": [ + "type_realtime:RealtimeBaseTranscript" + ], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "PartialTranscript" + } + }, + "description": "Describes the type of message" + } + ] + } + }, + "type_realtime:FinalTranscript": { + "name": "FinalTranscript", + "shape": { + "type": "object", + "extends": [ + "type_realtime:RealtimeBaseTranscript" + ], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "FinalTranscript" + } + }, + "description": "Describes the type of message" + }, + { + "key": "punctuated", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the text is punctuated and cased" + }, + { + "key": "text_formatted", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the text is formatted, for example Dollar -> $" + } + ] + } + }, + "type_realtime:Word": { + "name": "Word", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "start", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Start time of the word in milliseconds" + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "End time of the word in milliseconds" + }, + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + }, + "description": "Confidence score of the word" + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The word itself" + } + ] + } + }, + "type_realtime:AudioData": { + "name": "AudioData", + "description": "Binary audio data", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_realtime:ForceEndUtterance": { + "name": "ForceEndUtterance", + "description": "Manually end an utterance", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "force_end_utterance", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "A boolean value to communicate that you wish to force the end of the utterance" + } + ] + } + }, + "type_realtime:ConfigureEndUtteranceSilenceThreshold": { + "name": "ConfigureEndUtteranceSilenceThreshold", + "description": "Configure the threshold for how long to wait before ending an utterance. Default is 700ms.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "end_utterance_silence_threshold", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 20000 + } + }, + "description": "The duration threshold in milliseconds" + } + ] + } + }, + "type_realtime:TerminateSession": { + "name": "TerminateSession", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "terminate_session", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Set to true to end your streaming session forever" + } + ] + } + }, + "type_realtime:AudioEncoding": { + "name": "AudioEncoding", + "description": "The encoding of the audio data", + "shape": { + "type": "enum", + "values": [ + { + "description": "PCM signed 16-bit little-endian", + "value": "pcm_s16le" + }, + { + "description": "PCM Mu-law", + "value": "pcm_mulaw" + } + ] + } + }, + "type_realtime:RealtimeTemporaryTokenResponse": { + "name": "RealtimeTemporaryTokenResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The temporary authentication token for Streaming Speech-to-Text" + } + ] + } + }, + "type_lemur:PurgeLemurRequestDataResponse": { + "name": "PurgeLemurRequestDataResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "request_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the deletion request of the LeMUR request" + }, + { + "key": "request_id_to_purge", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the LeMUR request to purge the data for" + }, + { + "key": "deleted", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the request data was deleted" + } + ] + } + }, + "type_lemur:LemurBaseResponse": { + "name": "LemurBaseResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "request_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the LeMUR request" + } + ] + } + }, + "type_lemur:LemurSummaryResponse": { + "name": "LemurSummaryResponse", + "shape": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseResponse" + ], + "properties": [ + { + "key": "response", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The response generated by LeMUR" + } + ] + } + }, + "type_lemur:LemurQuestionAnswerResponse": { + "name": "LemurQuestionAnswerResponse", + "shape": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseResponse" + ], + "properties": [ + { + "key": "response", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_lemur:LemurQuestionAnswer" + } + }, + "description": "The answers generated by LeMUR and their questions" + } + ] + } + }, + "type_lemur:LemurQuestionAnswer": { + "name": "LemurQuestionAnswer", + "description": "An answer generated by LeMUR and its question", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "question", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The question for LeMUR to answer" + }, + { + "key": "answer", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The answer generated by LeMUR" + } + ] + } + }, + "type_lemur:LemurActionItemsResponse": { + "name": "LemurActionItemsResponse", + "shape": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseResponse" + ], + "properties": [ + { + "key": "response", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The response generated by LeMUR" + } + ] + } + }, + "type_lemur:LemurTaskResponse": { + "name": "LemurTaskResponse", + "shape": { + "type": "object", + "extends": [ + "type_lemur:LemurBaseResponse" + ], + "properties": [ + { + "key": "response", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The response generated by LeMUR." + } + ] + } + }, + "type_lemur:LemurBaseParamsContext": { + "name": "LemurBaseParamsContext", + "description": "Context to provide the model. This can be a string or a free-form JSON value.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_lemur:LemurBaseParams": { + "name": "LemurBaseParams", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "transcript_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.\nUse either transcript_ids or input_text as input into LeMUR." + }, + { + "key": "input_text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.\nUse either transcript_ids or input_text as input into LeMUR." + }, + { + "key": "context", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_lemur:LemurBaseParamsContext" + } + }, + "description": "Context to provide the model. This can be a string or a free-form JSON value." + }, + { + "key": "final_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_lemur:LemurModel" + } + }, + "description": "The model that is used for the final prompt after compression is performed.\nDefaults to \"default\"." + }, + { + "key": "max_output_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Max output size in tokens, up to 4000" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The temperature to use for the model.\nHigher values result in answers that are more creative, lower values are more conservative.\nCan be any value between 0.0 and 1.0 inclusive." + } + ] + } + }, + "type_lemur:LemurQuestionContext": { + "name": "LemurQuestionContext", + "description": "Any context about the transcripts you wish to provide. This can be a string or any object.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_lemur:LemurQuestion": { + "name": "LemurQuestion", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "question", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The question you wish to ask. For more complex questions use default model." + }, + { + "key": "context", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_lemur:LemurQuestionContext" + } + }, + "description": "Any context about the transcripts you wish to provide. This can be a string or any object." + }, + { + "key": "answer_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: \"short sentence\", \"bullet points\"" + }, + { + "key": "answer_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "What discrete options to return. Useful for precise responses. Can't be used with answer_format. Example: [\"Yes\", \"No\"]" + } + ] + } + }, + "type_lemur:LemurModel": { + "name": "LemurModel", + "description": "The model that is used for the final prompt after compression is performed.", + "shape": { + "type": "enum", + "values": [ + { + "description": "LeMUR Default is best at complex reasoning. It offers more nuanced responses and improved contextual comprehension.", + "value": "default" + }, + { + "description": "LeMUR Basic is a simplified model optimized for speed and cost. LeMUR Basic can complete requests up to 20% faster than Default.", + "value": "basic" + }, + { + "description": "LeMUR Mistral 7B is an LLM self-hosted by AssemblyAI. It's the fastest and cheapest of the LLM options. We recommend it for use cases like basic summaries and factual Q&A.", + "value": "assemblyai/mistral-7b" + }, + { + "description": "Claude 2.1 is similar to Default, with key improvements: it minimizes model hallucination and system prompts, has a larger context window, and performs better in citations.", + "value": "anthropic/claude-2-1" + } + ] + } + }, + "type_streaming:Streaming": { + "name": "Streaming", + "description": "The encoding of the audio data", + "shape": { + "type": "enum", + "values": [ + { + "description": "PCM signed 16-bit little-endian", + "value": "pcm_s16le" + }, + { + "description": "PCM Mu-law", + "value": "pcm_mulaw" + } + ] + } + }, + "type_streaming:receiveMessage": { + "name": "receiveMessage", + "description": "Receive messages from the WebSocket", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Session Begins", + "shape": { + "type": "id", + "id": "type_realtime:SessionBegins" + } + }, + { + "displayName": "Partial Transcript", + "shape": { + "type": "id", + "id": "type_realtime:PartialTranscript" + } + }, + { + "displayName": "Final Transcript", + "shape": { + "type": "id", + "id": "type_realtime:FinalTranscript" + } + }, + { + "displayName": "Session Information", + "shape": { + "type": "id", + "id": "type_realtime:SessionInformation" + } + }, + { + "displayName": "Session Terminated", + "shape": { + "type": "id", + "id": "type_realtime:SessionTerminated" + } + }, + { + "displayName": "Realtime Error", + "shape": { + "type": "id", + "id": "type_realtime:RealtimeError" + } + } + ] + } + }, + "type_streaming:sendMessage": { + "name": "sendMessage", + "description": "Send messages to the WebSocket", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Audio Data", + "shape": { + "type": "id", + "id": "type_realtime:AudioData" + } + }, + { + "displayName": "Terminate Session", + "shape": { + "type": "id", + "id": "type_realtime:TerminateSession" + } + }, + { + "displayName": "Force End Utterance", + "shape": { + "type": "id", + "id": "type_realtime:ForceEndUtterance" + } + }, + { + "displayName": "Configure End Utterance Silence Threshold", + "shape": { + "type": "id", + "id": "type_realtime:ConfigureEndUtteranceSilenceThreshold" + } + } + ] + } + }, + "type_:Error": { + "name": "Error", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Error message" + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "error" + } + } + } + } + ] + } + } + }, + "subpackages": { + "subpackage_files": { + "id": "subpackage_files", + "name": "files" + }, + "subpackage_transcripts": { + "id": "subpackage_transcripts", + "name": "transcripts" + }, + "subpackage_lemur": { + "id": "subpackage_lemur", + "name": "lemur", + "displayName": "LeMUR" + }, + "subpackage_streaming": { + "id": "subpackage_streaming", + "name": "streaming" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "Authorization", + "nameOverride": "apiKey" + } + } + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/node.json b/packages/fdr-sdk/src/__test__/output/assemblyai/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/node.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/assemblyai/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/assemblyai/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/pageIds.json b/packages/fdr-sdk/src/__test__/output/assemblyai/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/pageIds.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/sitemap.json b/packages/fdr-sdk/src/__test__/output/assemblyai/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/sitemap.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/assemblyai/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/assemblyai/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/slugs.json b/packages/fdr-sdk/src/__test__/output/assemblyai/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/slugs.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/assemblyai/versionNodes.json b/packages/fdr-sdk/src/__test__/output/assemblyai/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/assemblyai/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/assemblyai/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-7bbd8b60-d410-43c1-bda4-3c0813a4fbb7.json b/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-7bbd8b60-d410-43c1-bda4-3c0813a4fbb7.json new file mode 100644 index 0000000000..29549e2c41 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-7bbd8b60-d410-43c1-bda4-3c0813a4fbb7.json @@ -0,0 +1,1648 @@ +[ + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/query/supportPlan", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/query/product", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/query/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/query/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/query/sorts", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/query/isLookUpOnly", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/request/object/property/billingEmail", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/request/object/property/isScimEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/request/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/query/provider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/query/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/query/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/query/deploymentType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/query/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/query/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/query/names", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/query/provider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/query/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/query/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/query/sorts", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/path/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/path/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/path/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/query/deploymentIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/query/names", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/query/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/query/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/query/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/query/sorts", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/request/object/property/isHibernating", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/request/object/property/overrideUntil", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeploymentHibernationOverride/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeploymentHibernationOverride/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeploymentHibernationOverride/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/query/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/query/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/request/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/request/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/path/deployId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/path/deployId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/request/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/path/deployId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/request/object/property/dagTarballVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/path/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/path/deployId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/request/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/query/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/query/names", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/query/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/query/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/query/sorts", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/request/object/property/cicdEnforcedDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/request/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/request/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/path/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/path/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/request/object/property/cicdEnforcedDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/request/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/request/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/path/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/path/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/0/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/1/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/2/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/3/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/4/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/5/snippet/curl/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSupportPlan/shape/enum/value/TRIAL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSupportPlan/shape/enum/value/BASIC", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSupportPlan/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSupportPlan/shape/enum/value/PREMIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSupportPlan/shape/enum/value/BUSINESS_CRITICAL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestProduct/shape/enum/value/HOSTED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestProduct/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem/shape/enum/value/name:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem/shape/enum/value/name:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem/shape/enum/value/createdAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem/shape/enum/value/createdAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem/shape/enum/value/updatedAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem/shape/enum/value/updatedAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestDeploymentType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestDeploymentType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestDeploymentType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem/shape/enum/value/name:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem/shape/enum/value/name:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem/shape/enum/value/createdAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem/shape/enum/value/createdAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem/shape/enum/value/updatedAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem/shape/enum/value/updatedAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem/shape/enum/value/name:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem/shape/enum/value/name:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem/shape/enum/value/createdAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem/shape/enum/value/createdAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem/shape/enum/value/updatedAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem/shape/enum/value/updatedAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deploy:CreateDeployRequestType/shape/enum/value/IMAGE_AND_DAG", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deploy:CreateDeployRequestType/shape/enum/value/IMAGE_ONLY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deploy:CreateDeployRequestType/shape/enum/value/DAG_ONLY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem/shape/enum/value/name:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem/shape/enum/value/name:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem/shape/enum/value/createdAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem/shape/enum/value/createdAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem/shape/enum/value/updatedAt:asc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem/shape/enum/value/updatedAt:desc", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfileSubjectType/shape/enum/value/USER", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfileSubjectType/shape/enum/value/SERVICEKEY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape/object/property/apiTokenName", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape/object/property/avatarUrl", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape/object/property/fullName", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape/object/property/subjectType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape/object/property/username", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterStatus/shape/enum/value/CREATING", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterStatus/shape/enum/value/CREATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterStatus/shape/enum/value/CREATE_FAILED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterStatus/shape/enum/value/UPDATE_FAILED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterStatus/shape/enum/value/UPDATING", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/createdAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/dbInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/isLimited", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/metadata", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/nodePools", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/podSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/providerAccount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/region", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/servicePeeringRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/serviceSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/status", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/tags", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/tenantId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/vpcSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object/property/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterK8STag/shape/object/property/key", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterK8STag/shape/object/property/value", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterMetadata/shape/object/property/externalIPs", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterMetadata/shape/object/property/oidcIssuerUrl", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptionsProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptionsProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptionsProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/databaseInstances", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/defaultDatabaseInstance", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/defaultNodeInstance", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/defaultPodSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/defaultRegion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/defaultServicePeeringRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/defaultServiceSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/defaultVpcSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/nodeCountDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/nodeCountMax", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/nodeCountMin", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/nodeInstances", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/provider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object/property/regions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClustersPaginated/shape/object/property/clusters", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClustersPaginated/shape/object/property/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClustersPaginated/shape/object/property/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClustersPaginated/shape/object/property/totalCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/dbInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/k8sTags", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/nodePools", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/providerAccount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/region", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/vpcSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object/property/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/dbInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/k8sTags", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/nodePools", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/providerAccount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/region", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/tenantId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/vpcSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object/property/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateClusterRequest/shape/undiscriminatedUnion/variant/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateClusterRequest/shape/undiscriminatedUnion/variant/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateClusterRequest/shape/undiscriminatedUnion/variant/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestSchedulerSize/shape/enum/value/SMALL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestSchedulerSize/shape/enum/value/MEDIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestSchedulerSize/shape/enum/value/LARGE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/astroRuntimeVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/contactEmails", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/defaultTaskPodCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/defaultTaskPodMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/environmentVariables", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/isCicdEnforced", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/isDevelopmentMode", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/isHighAvailability", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/resourceQuotaCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/resourceQuotaMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/scalingSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/schedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/workloadIdentity", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object/property/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDeploymentRequest/shape/undiscriminatedUnion/variant/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDeploymentRequest/shape/undiscriminatedUnion/variant/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDeploymentRequest/shape/undiscriminatedUnion/variant/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/dbInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/k8sTags", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/nodePools", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/podSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/providerAccount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/region", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/servicePeeringRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/serviceSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/vpcSubnetRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object/property/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/astroRuntimeVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/contactEmails", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/environmentVariables", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/isCicdEnforced", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/scheduler", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/taskPodNodePoolId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/workloadIdentity", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object/property/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateNodePoolRequest/shape/object/property/isDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateNodePoolRequest/shape/object/property/maxNodeCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateNodePoolRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateNodePoolRequest/shape/object/property/nodeInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestSchedulerSize/shape/enum/value/SMALL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestSchedulerSize/shape/enum/value/MEDIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestSchedulerSize/shape/enum/value/LARGE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/astroRuntimeVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/contactEmails", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/defaultTaskPodCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/defaultTaskPodMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/environmentVariables", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/isCicdEnforced", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/isDevelopmentMode", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/isHighAvailability", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/region", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/resourceQuotaCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/resourceQuotaMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/scalingSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/schedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/workloadIdentity", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object/property/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployStatus/shape/enum/value/INITIALIZED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployStatus/shape/enum/value/DEPLOYED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployStatus/shape/enum/value/FAILED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployType/shape/enum/value/IMAGE_AND_DAG", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployType/shape/enum/value/IMAGE_ONLY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployType/shape/enum/value/DAG_ONLY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/airflowVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/astroRuntimeVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/createdAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/createdBySubject", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/dagTarballVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/dagsUploadUrl", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/deploymentId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/imageRepository", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/imageTag", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/rollbackFromId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/status", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object/property/updatedBySubject", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentSchedulerSize/shape/enum/value/SMALL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentSchedulerSize/shape/enum/value/MEDIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentSchedulerSize/shape/enum/value/LARGE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus/shape/enum/value/CREATING", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus/shape/enum/value/DEPLOYING", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus/shape/enum/value/HEALTHY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus/shape/enum/value/UNHEALTHY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus/shape/enum/value/UNKNOWN", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus/shape/enum/value/HIBERNATING", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/airflowVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/astroRuntimeVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/clusterName", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/contactEmails", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/createdAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/createdBy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/dagTarballVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/defaultTaskPodCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/defaultTaskPodMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/desiredDagTarballVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/environmentVariables", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/externalIPs", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/imageRepository", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/imageTag", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/imageVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/isCicdEnforced", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/isDevelopmentMode", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/isHighAvailability", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/namespace", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/oidcIssuerUrl", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/region", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/resourceQuotaCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/resourceQuotaMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/runtimeVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/scalingSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/scalingStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/schedulerAu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/schedulerCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/schedulerMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/schedulerReplicas", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/schedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/status", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/statusReason", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/taskPodNodePoolId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/updatedBy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/webServerAirflowApiUrl", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/webServerCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/webServerIngressHostname", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/webServerMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/webServerReplicas", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/webServerUrl", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/workloadIdentity", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object/property/workspaceName", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariable/shape/object/property/isSecret", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariable/shape/object/property/key", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariable/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariable/shape/object/property/value", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariableRequest/shape/object/property/isSecret", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariableRequest/shape/object/property/key", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariableRequest/shape/object/property/value", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverride/shape/object/property/isActive", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverride/shape/object/property/isHibernating", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverride/shape/object/property/overrideUntil", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverrideRequest/shape/object/property/isHibernating", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverrideRequest/shape/object/property/overrideUntil", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSchedule/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSchedule/shape/object/property/hibernateAtCron", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSchedule/shape/object/property/isEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSchedule/shape/object/property/wakeAtCron", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpec/shape/object/property/override", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpec/shape/object/property/schedules", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpecRequest/shape/object/property/override", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpecRequest/shape/object/property/schedules", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatusNextEventType/shape/enum/value/HIBERNATE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatusNextEventType/shape/enum/value/WAKE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatus/shape/object/property/isHibernating", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatus/shape/object/property/nextEventAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatus/shape/object/property/nextEventType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatus/shape/object/property/reason", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentInstanceSpecRequest/shape/object/property/au", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentInstanceSpecRequest/shape/object/property/replicas", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object/property/executors", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object/property/resourceQuotas", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object/property/runtimeReleases", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object/property/schedulerMachines", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object/property/workerMachines", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object/property/workloadIdentityOptions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpec/shape/object/property/hibernationSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpecRequest/shape/object/property/hibernationSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingStatus/shape/object/property/hibernationStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentsPaginated/shape/object/property/deployments", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentsPaginated/shape/object/property/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentsPaginated/shape/object/property/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentsPaginated/shape/object/property/totalCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploysPaginated/shape/object/property/deploys", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploysPaginated/shape/object/property/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploysPaginated/shape/object/property/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploysPaginated/shape/object/property/totalCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Error/shape/object/property/message", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Error/shape/object/property/requestId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Error/shape/object/property/statusCode", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object/property/isDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object/property/maxWorkerCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object/property/minWorkerCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object/property/nodePoolId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object/property/workerConcurrency", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:MachineSpec/shape/object/property/concurrency", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:MachineSpec/shape/object/property/cpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:MachineSpec/shape/object/property/ephemeralStorage", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:MachineSpec/shape/object/property/memory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomainStatus/shape/enum/value/PENDING", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomainStatus/shape/enum/value/VERIFIED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object/property/createdAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object/property/enforcedLogins", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object/property/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object/property/status", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePoolCloudProvider/shape/enum/value/AWS", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePoolCloudProvider/shape/enum/value/AZURE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePoolCloudProvider/shape/enum/value/GCP", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/cloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/clusterId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/createdAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/isDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/maxNodeCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/nodeInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/supportedAstroMachines", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationPaymentMethod/shape/enum/value/CREDIT_CARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationPaymentMethod/shape/enum/value/INVOICE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationPaymentMethod/shape/enum/value/AWS_MARKETPLACE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationPaymentMethod/shape/enum/value/AZURE_MARKETPLACE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationPaymentMethod/shape/enum/value/GCP_MARKETPLACE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationProduct/shape/enum/value/HOSTED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationProduct/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationStatus/shape/enum/value/ACTIVE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationStatus/shape/enum/value/INACTIVE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationStatus/shape/enum/value/SUSPENDED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationSupportPlan/shape/enum/value/TRIAL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationSupportPlan/shape/enum/value/BASIC", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationSupportPlan/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationSupportPlan/shape/enum/value/PREMIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationSupportPlan/shape/enum/value/BUSINESS_CRITICAL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/billingEmail", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/createdAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/createdBy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/isScimEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/managedDomains", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/paymentMethod", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/product", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/status", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/supportPlan", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/trialExpiresAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object/property/updatedBy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationsPaginated/shape/object/property/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationsPaginated/shape/object/property/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationsPaginated/shape/object/property/organizations", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationsPaginated/shape/object/property/totalCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderInstanceType/shape/object/property/cpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderInstanceType/shape/object/property/memory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderInstanceType/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderRegion/shape/object/property/bannedInstances", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderRegion/shape/object/property/limited", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderRegion/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Range/shape/object/property/ceiling", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Range/shape/object/property/default", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Range/shape/object/property/floor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceOption/shape/object/property/cpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceOption/shape/object/property/memory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceQuotaOptions/shape/object/property/defaultPodSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceQuotaOptions/shape/object/property/resourceQuota", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceRange/shape/object/property/ceiling", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceRange/shape/object/property/default", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceRange/shape/object/property/floor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape/object/property/airflowDatabaseMigration", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape/object/property/airflowVersion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape/object/property/channel", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape/object/property/releaseDate", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape/object/property/stellarDatabaseMigration", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape/object/property/version", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachineName/shape/enum/value/SMALL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachineName/shape/enum/value/MEDIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachineName/shape/enum/value/LARGE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachine/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachine/shape/object/property/spec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest/shape/object/property/dbInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest/shape/object/property/k8sTags", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest/shape/object/property/nodePools", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest/shape/object/property/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestSchedulerSize/shape/enum/value/SMALL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestSchedulerSize/shape/enum/value/MEDIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestSchedulerSize/shape/enum/value/LARGE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/contactEmails", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/defaultTaskPodCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/defaultTaskPodMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/environmentVariables", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/isCicdEnforced", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/isDevelopmentMode", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/isHighAvailability", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/resourceQuotaCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/resourceQuotaMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/scalingSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/schedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/workloadIdentity", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object/property/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDeploymentRequest/shape/undiscriminatedUnion/variant/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDeploymentRequest/shape/undiscriminatedUnion/variant/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDeploymentRequest/shape/undiscriminatedUnion/variant/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridClusterRequest/shape/object/property/workspaceIds", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/contactEmails", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/environmentVariables", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/isCicdEnforced", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/scheduler", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/taskPodNodePoolId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/workloadIdentity", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object/property/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest/shape/object/property/isDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest/shape/object/property/maxNodeCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest/shape/object/property/nodeInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestExecutor/shape/enum/value/CELERY", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestExecutor/shape/enum/value/KUBERNETES", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestSchedulerSize/shape/enum/value/SMALL", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestSchedulerSize/shape/enum/value/MEDIUM", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestSchedulerSize/shape/enum/value/LARGE", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestType/shape/enum/value/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestType/shape/enum/value/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestType/shape/enum/value/STANDARD", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/contactEmails", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/defaultTaskPodCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/defaultTaskPodMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/environmentVariables", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/executor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/isCicdEnforced", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/isDagDeployEnabled", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/isDevelopmentMode", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/isHighAvailability", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/resourceQuotaCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/resourceQuotaMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/scalingSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/schedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/type", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/workerQueues", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/workloadIdentity", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object/property/workspaceId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape/enum/value/A5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape/enum/value/A10", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape/enum/value/A20", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape/enum/value/A40", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape/enum/value/A60", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape/enum/value/A120", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape/enum/value/A160", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachine/shape/object/property/concurrency", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachine/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachine/shape/object/property/spec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/astroMachine", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/isDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/maxWorkerCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/minWorkerCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/nodePoolId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/podCpu", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/podMemory", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object/property/workerConcurrency", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueOptions/shape/object/property/maxWorkers", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueOptions/shape/object/property/minWorkers", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueOptions/shape/object/property/workerConcurrency", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape/enum/value/A5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape/enum/value/A10", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape/enum/value/A20", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape/enum/value/A40", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape/enum/value/A60", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape/enum/value/A120", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape/enum/value/A160", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object/property/astroMachine", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object/property/isDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object/property/maxWorkerCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object/property/minWorkerCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object/property/workerConcurrency", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkloadIdentityOption/shape/object/property/label", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkloadIdentityOption/shape/object/property/role", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/cicdEnforcedDefault", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/createdAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/createdBy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/description", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/id", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/name", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/organizationId", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/organizationName", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/updatedAt", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object/property/updatedBy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkspacesPaginated/shape/object/property/limit", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkspacesPaginated/shape/object/property/offset", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkspacesPaginated/shape/object/property/totalCount", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkspacesPaginated/shape/object/property/workspaces", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/3/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/3/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/3/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/3/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/3/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/3/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/3/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/response", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/0/400/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/1/401/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/2/403/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/3/404/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/4/500/error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateClusterRequest/shape/discriminatedUnion/variant/DEDICATED", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateClusterRequest/shape/discriminatedUnion/variant/HYBRID", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/request/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterK8STag/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterMetadata/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClustersPaginated/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateNodePoolRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariable/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariableRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverride/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverrideRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSchedule/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpec/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpecRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatus/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentInstanceSpecRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpec/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpecRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingStatus/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentsPaginated/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploysPaginated/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Error/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:MachineSpec/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationsPaginated/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderInstanceType/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderRegion/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Range/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceOption/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceQuotaOptions/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceRange/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachine/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridClusterRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachine/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueOptions/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkloadIdentityOption/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkspacesPaginated/shape/object", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSupportPlan/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestProduct/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestDeploymentType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deploy:CreateDeployRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfileSubjectType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterStatus/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptionsProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateClusterRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestSchedulerSize/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestSchedulerSize/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployStatus/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentSchedulerSize/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatusNextEventType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomainStatus/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePoolCloudProvider/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationPaymentMethod/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationProduct/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationStatus/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationSupportPlan/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachineName/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestSchedulerSize/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestExecutor/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestSchedulerSize/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/error/3/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/error/3/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/error/3/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/error/3/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/error/3/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeploymentHibernationOverride/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/error/3/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/error/3/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/0/400", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/1/401", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/2/403", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/3/404", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/error/4/500", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/0", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/1", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/2", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/3", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/4", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace/example/5", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace/request", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSupportPlan", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestProduct", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_organization:ListOrganizationsRequestSortsItem", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetClusterOptionsRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestDeploymentType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_options:GetDeploymentOptionsRequestCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_cluster:ListClustersRequestSortsItem", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deployment:ListDeploymentsRequestSortsItem", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_deploy:CreateDeployRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_workspace:ListWorkspacesRequestSortsItem", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfileSubjectType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterK8STag/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterMetadata/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptionsProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClustersPaginated/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateClusterRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestSchedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateNodePoolRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestSchedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeployType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentSchedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariable/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariableRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverride/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverrideRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSchedule/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpec/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpecRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatusNextEventType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatus/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentInstanceSpecRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpec/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpecRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingStatus/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentsPaginated/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploysPaginated/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Error/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:MachineSpec/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomainStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePoolCloudProvider", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationPaymentMethod", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationProduct", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationSupportPlan", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationsPaginated/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderInstanceType/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderRegion/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Range/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceOption/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceQuotaOptions/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceRange/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachineName", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachine/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateClusterRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestSchedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridClusterRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestExecutor", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestSchedulerSize", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequestType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachineName", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachine/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueOptions/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequestAstroMachine", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkloadIdentityOption/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkspacesPaginated/shape", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:BasicSubjectProfile", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Cluster", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterK8STag", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterMetadata", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClusterOptions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ClustersPaginated", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAwsClusterRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateAzureClusterRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateDedicatedDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateGcpClusterRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateHybridDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateNodePoolRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:CreateStandardDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deploy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Deployment", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariable", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentEnvironmentVariableRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverride", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationOverrideRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSchedule", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationSpecRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentHibernationStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentInstanceSpecRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentOptions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingSpecRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentScalingStatus", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploymentsPaginated", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:DeploysPaginated", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Error", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:HybridWorkerQueueRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:MachineSpec", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ManagedDomain", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:NodePool", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Organization", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:OrganizationsPaginated", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderInstanceType", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ProviderRegion", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Range", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceOption", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceQuotaOptions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:ResourceRange", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:RuntimeRelease", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:SchedulerMachine", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateClusterRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedClusterRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateDedicatedDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridClusterRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateHybridDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateNodePoolRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:UpdateStandardDeploymentRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerMachine", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueue", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueOptions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkerQueueRequest", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkloadIdentityOption", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:Workspace", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/type-definition/type_:WorkspacesPaginated", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.ListOrganizations", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.GetOrganization", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_organization.UpdateOrganization", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetClusterOptions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_options.GetDeploymentOptions", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.ListClusters", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.CreateCluster", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.GetCluster", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.UpdateCluster", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_cluster.DeleteCluster", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.ListDeployments", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.CreateDeployment", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.GetDeployment", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeployment", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeployment", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.UpdateDeploymentHibernationOverride", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deployment.DeleteDeploymentHibernationOverride", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.ListDeploys", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.CreateDeploy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.GetDeploy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.UpdateDeploy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.FinalizeDeploy", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_deploy.DeployRollback", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.ListWorkspaces", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.CreateWorkspace", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.GetWorkspace", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.UpdateWorkspace", + "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7/endpoint/subpackage_workspace.DeleteWorkspace" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-a4030141-9ea5-4ac9-8d2b-f44b815980a8.json b/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-a4030141-9ea5-4ac9-8d2b-f44b815980a8.json new file mode 100644 index 0000000000..b8c03b37fe --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitionKeys-a4030141-9ea5-4ac9-8d2b-f44b815980a8.json @@ -0,0 +1,1135 @@ +[ + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/query/scopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/request/object/property/inviteeEmail", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/request/object/property/role", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/path/inviteId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/query/scopeTypes", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/query/includeDefaultRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/query/scopeTypes", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/query/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/query/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/query/sorts", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/request/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/request/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/request/object/property/permissions", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/request/object/property/restrictedWorkspaceIds", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/request/object/property/scopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/path/customRoleId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/request/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/request/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/request/object/property/permissions", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/request/object/property/restrictedWorkspaceIds", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/path/customRoleId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/path/roleId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/query/names", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/query/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/query/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/query/sorts", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/request/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/request/object/property/memberIds", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/request/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/request/object/property/organizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/path/teamId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/path/teamId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/request/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/request/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/path/teamId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/path/teamId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/query/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/query/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/query/sorts", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/path/teamId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/request/object/property/memberIds", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/path/teamId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/path/memberId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/path/teamId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/request/object/property/deploymentRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/request/object/property/organizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/request/object/property/workspaceRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/query/workspaceId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/query/deploymentId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/query/includeOnlyOrganizationTokens", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/query/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/query/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/query/sorts", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request/object/property/entityId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request/object/property/role", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request/object/property/tokenExpiryPeriodInDays", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request/object/property/type", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/path/tokenId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/path/tokenId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/request/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/request/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/path/tokenId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/path/tokenId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/request/object/property/roles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/path/tokenId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/query/workspaceId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/query/deploymentId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/query/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/query/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/query/sorts", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/path/userId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/path/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/path/userId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/request/object/property/deploymentRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/request/object/property/organizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/request/object/property/workspaceRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/0/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/1/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/2/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/3/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/4/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/5/snippet/curl/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_authorization:ListPermissionGroupsRequestScopeType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_authorization:ListPermissionGroupsRequestScopeType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_authorization:ListPermissionGroupsRequestScopeType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_invite:CreateUserInviteRequestRole/shape/enum/value/ORGANIZATION_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_invite:CreateUserInviteRequestRole/shape/enum/value/ORGANIZATION_BILLING_ADMIN", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_invite:CreateUserInviteRequestRole/shape/enum/value/ORGANIZATION_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRoleTemplatesRequestScopeTypesItem/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRoleTemplatesRequestScopeTypesItem/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRoleTemplatesRequestScopeTypesItem/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestScopeTypesItem/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestScopeTypesItem/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestScopeTypesItem/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/name:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/name:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/scopeType:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/scopeType:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/description:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/description:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/createdAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/createdAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/updatedAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape/enum/value/updatedAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/name:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/name:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/description:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/description:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/createdAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/createdAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/updatedAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape/enum/value/updatedAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:CreateTeamRequestOrganizationRole/shape/enum/value/ORGANIZATION_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:CreateTeamRequestOrganizationRole/shape/enum/value/ORGANIZATION_BILLING_ADMIN", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:CreateTeamRequestOrganizationRole/shape/enum/value/ORGANIZATION_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/userId:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/userId:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/fullName:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/fullName:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/username:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/username:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/createdAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape/enum/value/createdAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:UpdateTeamRolesRequestOrganizationRole/shape/enum/value/ORGANIZATION_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:UpdateTeamRolesRequestOrganizationRole/shape/enum/value/ORGANIZATION_BILLING_ADMIN", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:UpdateTeamRolesRequestOrganizationRole/shape/enum/value/ORGANIZATION_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/name:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/name:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/description:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/description:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/createdAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/createdAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/updatedAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/updatedAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/tokenStartAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape/enum/value/tokenStartAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:CreateApiTokenRequestType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:CreateApiTokenRequestType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:CreateApiTokenRequestType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/id:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/id:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/username:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/username:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/fullName:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/fullName:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/createdAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/createdAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/updatedAt:asc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape/enum/value/updatedAt:desc", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:UpdateUserRolesRequestOrganizationRole/shape/enum/value/ORGANIZATION_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:UpdateUserRolesRequestOrganizationRole/shape/enum/value/ORGANIZATION_BILLING_ADMIN", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:UpdateUserRolesRequestOrganizationRole/shape/enum/value/ORGANIZATION_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/createdAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/createdBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/endAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/expiryPeriodInDays", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/id", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/lastUsedAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/roles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/shortToken", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/startAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/token", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/type", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/updatedAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object/property/updatedBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRoleEntityType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRoleEntityType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRoleEntityType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRole/shape/object/property/entityId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRole/shape/object/property/entityType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRole/shape/object/property/role", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokensPaginated/shape/object/property/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokensPaginated/shape/object/property/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokensPaginated/shape/object/property/tokens", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokensPaginated/shape/object/property/totalCount", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfileSubjectType/shape/enum/value/USER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfileSubjectType/shape/enum/value/SERVICEKEY", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape/object/property/apiTokenName", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape/object/property/avatarUrl", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape/object/property/fullName", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape/object/property/id", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape/object/property/subjectType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape/object/property/username", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRoleScopeType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRoleScopeType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRoleScopeType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRoleScopeType/shape/enum/value/SYSTEM", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRole/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRole/shape/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRole/shape/object/property/permissions", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRole/shape/object/property/scopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DeploymentRole/shape/object/property/deploymentId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DeploymentRole/shape/object/property/role", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Error/shape/object/property/message", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Error/shape/object/property/requestId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Error/shape/object/property/statusCode", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object/property/expiresAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object/property/inviteId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object/property/invitee", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object/property/inviter", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object/property/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object/property/organizationName", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object/property/userId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionEntry/shape/object/property/action", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionEntry/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionGroup/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionGroup/shape/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionGroup/shape/object/property/permissions", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionGroup/shape/object/property/scope", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleScopeType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleScopeType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleScopeType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/createdAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/createdBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/id", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/restrictedWorkspaceIds", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/scopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/updatedAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object/property/updatedBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplateScopeType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplateScopeType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplateScopeType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplateScopeType/shape/enum/value/SYSTEM", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplate/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplate/shape/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplate/shape/object/property/permissions", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplate/shape/object/property/scopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermissionScopeType/shape/enum/value/DEPLOYMENT", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermissionScopeType/shape/enum/value/WORKSPACE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermissionScopeType/shape/enum/value/ORGANIZATION", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/createdAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/createdBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/id", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/permissions", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/restrictedWorkspaceIds", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/scopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/updatedAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object/property/updatedBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated/shape/object/property/defaultRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated/shape/object/property/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated/shape/object/property/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated/shape/object/property/roles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated/shape/object/property/totalCount", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRolesOrganizationRole/shape/enum/value/ORGANIZATION_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRolesOrganizationRole/shape/enum/value/ORGANIZATION_BILLING_ADMIN", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRolesOrganizationRole/shape/enum/value/ORGANIZATION_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRoles/shape/object/property/deploymentRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRoles/shape/object/property/organizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRoles/shape/object/property/workspaceRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamOrganizationRole/shape/enum/value/ORGANIZATION_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamOrganizationRole/shape/enum/value/ORGANIZATION_BILLING_ADMIN", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamOrganizationRole/shape/enum/value/ORGANIZATION_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/createdAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/createdBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/deploymentRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/description", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/id", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/isIdpManaged", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/name", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/organizationId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/organizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/rolesCount", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/updatedAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/updatedBy", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object/property/workspaceRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember/shape/object/property/avatarUrl", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember/shape/object/property/createdAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember/shape/object/property/fullName", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember/shape/object/property/userId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember/shape/object/property/username", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMembersPaginated/shape/object/property/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMembersPaginated/shape/object/property/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMembersPaginated/shape/object/property/teamMembers", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMembersPaginated/shape/object/property/totalCount", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamsPaginated/shape/object/property/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamsPaginated/shape/object/property/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamsPaginated/shape/object/property/teams", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamsPaginated/shape/object/property/totalCount", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserOrganizationRole/shape/enum/value/ORGANIZATION_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserOrganizationRole/shape/enum/value/ORGANIZATION_BILLING_ADMIN", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserOrganizationRole/shape/enum/value/ORGANIZATION_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserStatus/shape/enum/value/ACTIVE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserStatus/shape/enum/value/INACTIVE", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserStatus/shape/enum/value/PENDING", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserStatus/shape/enum/value/BANNED", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/avatarUrl", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/createdAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/deploymentRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/fullName", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/id", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/organizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/status", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/updatedAt", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/username", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object/property/workspaceRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UsersPaginated/shape/object/property/limit", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UsersPaginated/shape/object/property/offset", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UsersPaginated/shape/object/property/totalCount", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UsersPaginated/shape/object/property/users", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRoleRole/shape/enum/value/WORKSPACE_OWNER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRoleRole/shape/enum/value/WORKSPACE_OPERATOR", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRoleRole/shape/enum/value/WORKSPACE_AUTHOR", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRoleRole/shape/enum/value/WORKSPACE_MEMBER", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRoleRole/shape/enum/value/WORKSPACE_ACCESSOR", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRole/shape/object/property/role", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRole/shape/object/property/workspaceId", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/3/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/3/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/response", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/0/400/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/1/401/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/2/403/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/3/404/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/4/500/error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/request/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRole/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokensPaginated/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRole/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DeploymentRole/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Error/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionEntry/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionGroup/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplate/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRoles/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMembersPaginated/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamsPaginated/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UsersPaginated/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRole/shape/object", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_authorization:ListPermissionGroupsRequestScopeType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_invite:CreateUserInviteRequestRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRoleTemplatesRequestScopeTypesItem/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestScopeTypesItem/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:CreateTeamRequestOrganizationRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:UpdateTeamRolesRequestOrganizationRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:CreateApiTokenRequestType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:UpdateUserRolesRequestOrganizationRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRoleEntityType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfileSubjectType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRoleScopeType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleScopeType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplateScopeType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermissionScopeType/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRolesOrganizationRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamOrganizationRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserOrganizationRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserStatus/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRoleRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/error/3/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/error/3/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/0/400", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/1/401", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/2/403", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/3/404", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/error/4/500", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/0", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/1", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/2", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/3", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/4", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/example/5", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles/request", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_authorization:ListPermissionGroupsRequestScopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_invite:CreateUserInviteRequestRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRoleTemplatesRequestScopeTypesItem", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestScopeTypesItem", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_role:ListRolesRequestSortsItem", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamsRequestSortsItem", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:CreateTeamRequestOrganizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:ListTeamMembersRequestSortsItem", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_team:UpdateTeamRolesRequestOrganizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:ListApiTokensRequestSortsItem", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_apiToken:CreateApiTokenRequestType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:ListUsersRequestSortsItem", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_user:UpdateUserRolesRequestOrganizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRoleEntityType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokensPaginated/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfileSubjectType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRoleScopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DeploymentRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Error/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionEntry/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionGroup/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleScopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplateScopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplate/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermissionScopeType", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRolesOrganizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRoles/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamOrganizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMembersPaginated/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamsPaginated/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserOrganizationRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UserStatus", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UsersPaginated/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRoleRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRole/shape", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiToken", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokenRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:ApiTokensPaginated", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:BasicSubjectProfile", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DefaultRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:DeploymentRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Error", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Invite", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionEntry", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:PermissionGroup", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Role", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleTemplate", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RoleWithPermission", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:RolesPaginated", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:SubjectRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:Team", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMember", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamMembersPaginated", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:TeamsPaginated", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:User", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:UsersPaginated", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/type-definition/type_:WorkspaceRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_authorization.ListPermissionGroups", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.CreateUserInvite", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_invite.DeleteUserInvite", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoleTemplates", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.ListRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.CreateCustomRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.UpdateCustomRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.DeleteCustomRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_role.GetCustomRole", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeams", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.CreateTeam", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.GetTeam", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeam", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.DeleteTeam", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.ListTeamMembers", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.AddTeamMembers", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.RemoveTeamMember", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_team.UpdateTeamRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.ListApiTokens", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.CreateApiToken", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.GetApiToken", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiToken", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.DeleteApiToken", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.UpdateApiTokenRoles", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_apiToken.RotateApiToken", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.ListUsers", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.GetUser", + "a4030141-9ea5-4ac9-8d2b-f44b815980a8/endpoint/subpackage_user.UpdateUserRoles" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitions.json new file mode 100644 index 0000000000..6ef6e3b1c1 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/astronomer/apiDefinitions.json @@ -0,0 +1,27771 @@ +[ + { + "id": "7bbd8b60-d410-43c1-bda4-3c0813a4fbb7", + "endpoints": { + "subpackage_organization.ListOrganizations": { + "id": "subpackage_organization.ListOrganizations", + "namespace": [ + "subpackage_organization" + ], + "description": "List the details about all Organizations that you have access to. Requires using a personal access token (PAT) for authentication.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "queryParameters": [ + { + "key": "supportPlan", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_organization:ListOrganizationsRequestSupportPlan" + } + }, + "description": "Filters the Organization list by support plan." + }, + { + "key": "product", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_organization:ListOrganizationsRequestProduct" + } + }, + "description": "Filters the Organization list by product." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results to skip before returning values." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to return." + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_organization:ListOrganizationsRequestSortsItem" + } + }, + "description": "A list of field names to sort by, and whether to show results as ascending or descending. Formatted as `:asc` or `:desc`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationsPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "limit": 10, + "offset": 0, + "organizations": [ + { + "createdAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "id": "clmaxoarx000008l2c5ayb9pt", + "isScimEnabled": false, + "name": "My organization", + "supportPlan": "TRIAL", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "billingEmail": "billing@company.com", + "managedDomains": [ + { + "createdAt": "2024-01-15T09:30:00Z", + "id": "cln203mz7000008jv0jyz9m3y", + "name": "mycompany.com", + "organizationId": "cln204xr2000008mu3hhe3zwe", + "status": "PENDING", + "updatedAt": "2024-01-15T09:30:00Z" + } + ], + "paymentMethod": "CREDIT_CARD", + "product": "HOSTED", + "status": "ACTIVE", + "trialExpiresAt": "2022-11-22T04:37:12Z" + } + ], + "totalCount": 100 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "supportPlan": "TRIAL", + "product": "HOSTED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations \\\n -H \"Authorization: Bearer \" \\\n -d supportPlan=TRIAL \\\n -d product=HOSTED", + "generated": true + } + ] + } + }, + { + "path": "/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "supportPlan": "TRIAL", + "product": "HOSTED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations \\\n -H \"Authorization: Bearer \" \\\n -d supportPlan=TRIAL \\\n -d product=HOSTED", + "generated": true + } + ] + } + }, + { + "path": "/organizations", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": { + "supportPlan": "TRIAL", + "product": "HOSTED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations \\\n -H \"Authorization: Bearer \" \\\n -d supportPlan=TRIAL \\\n -d product=HOSTED", + "generated": true + } + ] + } + }, + { + "path": "/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "supportPlan": "TRIAL", + "product": "HOSTED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations \\\n -H \"Authorization: Bearer \" \\\n -d supportPlan=TRIAL \\\n -d product=HOSTED", + "generated": true + } + ] + } + } + ] + }, + "subpackage_organization.GetOrganization": { + "id": "subpackage_organization.GetOrganization", + "namespace": [ + "subpackage_organization" + ], + "description": "Retrieve information about a specific Organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's ID." + } + ], + "queryParameters": [ + { + "key": "isLookUpOnly", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to show only Organization metadata." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Organization" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "clmaxoarx000008l2c5ayb9pt", + "isScimEnabled": false, + "name": "My organization", + "supportPlan": "TRIAL", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "billingEmail": "billing@company.com", + "managedDomains": [ + { + "createdAt": "2024-01-15T09:30:00Z", + "id": "cln203mz7000008jv0jyz9m3y", + "name": "mycompany.com", + "organizationId": "cln204xr2000008mu3hhe3zwe", + "status": "PENDING", + "updatedAt": "2024-01-15T09:30:00Z", + "enforcedLogins": [ + "enforcedLogins" + ] + } + ], + "paymentMethod": "CREDIT_CARD", + "product": "HOSTED", + "status": "ACTIVE", + "trialExpiresAt": "2022-11-22T04:37:12Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "isLookUpOnly": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -d isLookUpOnly=true", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "isLookUpOnly": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -d isLookUpOnly=true", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "isLookUpOnly": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -d isLookUpOnly=true", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "isLookUpOnly": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -d isLookUpOnly=true", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "isLookUpOnly": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -d isLookUpOnly=true", + "generated": true + } + ] + } + } + ] + }, + "subpackage_organization.UpdateOrganization": { + "id": "subpackage_organization.UpdateOrganization", + "namespace": [ + "subpackage_organization" + ], + "description": "Update an Organization's details.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "billingEmail", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's billing email." + }, + { + "key": "isScimEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether SCIM is enabled for the Organization." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the Organization." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Organization" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "billingEmail": "billing@company.com", + "isScimEnabled": false, + "name": "My Organization" + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "clmaxoarx000008l2c5ayb9pt", + "isScimEnabled": false, + "name": "My organization", + "supportPlan": "TRIAL", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "billingEmail": "billing@company.com", + "managedDomains": [ + { + "createdAt": "2024-01-15T09:30:00Z", + "id": "cln203mz7000008jv0jyz9m3y", + "name": "mycompany.com", + "organizationId": "cln204xr2000008mu3hhe3zwe", + "status": "PENDING", + "updatedAt": "2024-01-15T09:30:00Z", + "enforcedLogins": [ + "enforcedLogins" + ] + } + ], + "paymentMethod": "CREDIT_CARD", + "product": "HOSTED", + "status": "ACTIVE", + "trialExpiresAt": "2022-11-22T04:37:12Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"billingEmail\": \"billing@company.com\",\n \"isScimEnabled\": false,\n \"name\": \"My Organization\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "billingEmail": "string", + "isScimEnabled": true, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"billingEmail\": \"string\",\n \"isScimEnabled\": true,\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "billingEmail": "string", + "isScimEnabled": true, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"billingEmail\": \"string\",\n \"isScimEnabled\": true,\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "billingEmail": "string", + "isScimEnabled": true, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"billingEmail\": \"string\",\n \"isScimEnabled\": true,\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "billingEmail": "string", + "isScimEnabled": true, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"billingEmail\": \"string\",\n \"isScimEnabled\": true,\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "billingEmail": "string", + "isScimEnabled": true, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"billingEmail\": \"string\",\n \"isScimEnabled\": true,\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_options.GetClusterOptions": { + "id": "subpackage_options.GetClusterOptions", + "namespace": [ + "subpackage_options" + ], + "description": "Get all possible options for configuring a cluster.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/cluster-options" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to get cluster options for." + } + ], + "queryParameters": [ + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_options:GetClusterOptionsRequestProvider" + } + }, + "description": "The cluster's cloud provider." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_options:GetClusterOptionsRequestType" + }, + "description": "The cluster type." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ClusterOptions" + } + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/cluster-options", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": { + "type": "DEDICATED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "databaseInstances": [ + { + "cpu": 4, + "memory": "16Gi", + "name": "e2-standard-4" + } + ], + "defaultDatabaseInstance": { + "cpu": 4, + "memory": "16Gi", + "name": "e2-standard-4" + }, + "defaultNodeInstance": { + "cpu": 4, + "memory": "16Gi", + "name": "e2-standard-4" + }, + "defaultRegion": { + "name": "us-east-1", + "bannedInstances": [ + "bannedInstances" + ], + "limited": true + }, + "defaultVpcSubnetRange": "172.20.0.0/19", + "nodeCountDefault": 20, + "nodeCountMax": 100, + "nodeCountMin": 2, + "nodeInstances": [ + { + "cpu": 4, + "memory": "16Gi", + "name": "e2-standard-4" + } + ], + "provider": "AWS", + "regions": [ + { + "name": "us-east-1", + "limited": true + } + ], + "defaultPodSubnetRange": "172.21.0.0/19", + "defaultServicePeeringRange": "172.23.0.0/20", + "defaultServiceSubnetRange": "172.22.0.0/22" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId/cluster-options \\\n -H \"Authorization: Bearer \" \\\n -d type=DEDICATED", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/cluster-options", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "provider": "AWS", + "type": "DEDICATED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/cluster-options \\\n -H \"Authorization: Bearer \" \\\n -d provider=AWS \\\n -d type=DEDICATED", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/cluster-options", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "provider": "AWS", + "type": "DEDICATED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/cluster-options \\\n -H \"Authorization: Bearer \" \\\n -d provider=AWS \\\n -d type=DEDICATED", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/cluster-options", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "provider": "AWS", + "type": "DEDICATED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/cluster-options \\\n -H \"Authorization: Bearer \" \\\n -d provider=AWS \\\n -d type=DEDICATED", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/cluster-options", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "provider": "AWS", + "type": "DEDICATED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/cluster-options \\\n -H \"Authorization: Bearer \" \\\n -d provider=AWS \\\n -d type=DEDICATED", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/cluster-options", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "provider": "AWS", + "type": "DEDICATED" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/cluster-options \\\n -H \"Authorization: Bearer \" \\\n -d provider=AWS \\\n -d type=DEDICATED", + "generated": true + } + ] + } + } + ] + }, + "subpackage_options.GetDeploymentOptions": { + "id": "subpackage_options.GetDeploymentOptions", + "namespace": [ + "subpackage_options" + ], + "description": "Get the options available for configuring a Deployment.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployment-options" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to retrieve Deployment options for." + } + ], + "queryParameters": [ + { + "key": "deploymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of a Deployment to retrieve options for." + }, + { + "key": "deploymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_options:GetDeploymentOptionsRequestDeploymentType" + } + }, + "description": "The runtime type of the deployment." + }, + { + "key": "executor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_options:GetDeploymentOptionsRequestExecutor" + } + }, + "description": "The executor of the deployment." + }, + { + "key": "cloudProvider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_options:GetDeploymentOptionsRequestCloudProvider" + } + }, + "description": "The cloud provider of the cluster for the deployment." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DeploymentOptions" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployment-options", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "executors": [ + "executors" + ], + "resourceQuotas": { + "defaultPodSize": { + "cpu": { + "ceiling": "10", + "default": "5", + "floor": "1" + }, + "memory": { + "ceiling": "10", + "default": "5", + "floor": "1" + } + }, + "resourceQuota": { + "cpu": { + "ceiling": "10", + "default": "5", + "floor": "1" + }, + "memory": { + "ceiling": "10", + "default": "5", + "floor": "1" + } + } + }, + "runtimeReleases": [ + { + "airflowDatabaseMigration": false, + "airflowVersion": "2.7.1", + "channel": "stable", + "releaseDate": "2022-11-22T04:37:12Z", + "stellarDatabaseMigration": false, + "version": "9.1.0" + } + ], + "schedulerMachines": [ + { + "name": "SMALL", + "spec": { + "cpu": "1", + "memory": "2Gi", + "concurrency": 10, + "ephemeralStorage": "10Gi" + } + } + ], + "workerMachines": [ + { + "concurrency": { + "ceiling": 10, + "default": 5, + "floor": 1 + }, + "name": "A5", + "spec": { + "cpu": "1", + "memory": "2Gi", + "concurrency": 10, + "ephemeralStorage": "10Gi" + } + } + ], + "workerQueues": { + "maxWorkers": { + "ceiling": 10, + "default": 5, + "floor": 1 + }, + "minWorkers": { + "ceiling": 10, + "default": 5, + "floor": 1 + }, + "workerConcurrency": { + "ceiling": 10, + "default": 5, + "floor": 1 + } + }, + "workloadIdentityOptions": [ + { + "label": "workload-label", + "role": "workload-role" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployment-options \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployment-options", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentId": "string", + "deploymentType": "HYBRID" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployment-options \\\n -H \"Authorization: Bearer \" \\\n -d deploymentId=string \\\n -d deploymentType=HYBRID", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployment-options", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentId": "string", + "deploymentType": "HYBRID" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployment-options \\\n -H \"Authorization: Bearer \" \\\n -d deploymentId=string \\\n -d deploymentType=HYBRID", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployment-options", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentId": "string", + "deploymentType": "HYBRID" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployment-options \\\n -H \"Authorization: Bearer \" \\\n -d deploymentId=string \\\n -d deploymentType=HYBRID", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployment-options", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentId": "string", + "deploymentType": "HYBRID" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployment-options \\\n -H \"Authorization: Bearer \" \\\n -d deploymentId=string \\\n -d deploymentType=HYBRID", + "generated": true + } + ] + } + } + ] + }, + "subpackage_cluster.ListClusters": { + "id": "subpackage_cluster.ListClusters", + "namespace": [ + "subpackage_cluster" + ], + "description": "List clusters in an Organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/clusters" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's unique ID." + } + ], + "queryParameters": [ + { + "key": "names", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of names for Clusters to filter by. The API returns details only for the specified Clusters." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_cluster:ListClustersRequestProvider" + } + }, + "description": "The cloud provider to list clusters for. Clusters from other providers will be filtered out of the results." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results to skip before returning values." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to return." + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_cluster:ListClustersRequestSortsItem" + } + }, + "description": "A list of field names to sort by, and whether to show results as ascending or descending. Formatted as `:asc` or `:desc`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClustersPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/clusters", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "clusters": [ + { + "cloudProvider": "AWS", + "createdAt": "2022-11-22T04:37:12Z", + "dbInstanceType": "db.t3.medium", + "id": "clm7k8tgw000008jz97i37y81", + "name": "my cluster", + "organizationId": "clm88r8hi000008jwhzxu5crg", + "region": "us-east-1", + "status": "CREATING", + "type": "DEDICATED", + "updatedAt": "2022-11-22T04:37:12Z", + "vpcSubnetRange": "172.20.0.0/22", + "isLimited": false, + "metadata": { + "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/" + }, + "nodePools": [ + { + "cloudProvider": "AWS", + "clusterId": "clm891jb6000308jrc3vjdtde", + "createdAt": "2022-11-22T04:37:12Z", + "id": "clm890zhe000208jr39dd0ubs", + "isDefault": true, + "maxNodeCount": 1, + "name": "default", + "nodeInstanceType": "t3.medium", + "updatedAt": "2022-11-22T04:37:12Z" + } + ], + "podSubnetRange": "172.21.0.0/19", + "providerAccount": "provider-account", + "servicePeeringRange": "172.23.0.0/20", + "serviceSubnetRange": "172.22.0.0/22", + "tags": [ + { + "key": "key1", + "value": "value1" + } + ], + "tenantId": "your-tenant-id", + "workspaceIds": [ + "workspaceIds" + ] + } + ], + "limit": 10, + "offset": 0, + "totalCount": 100 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/clusters \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "provider": "AWS" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d provider=AWS", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "provider": "AWS" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d provider=AWS", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "provider": "AWS" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d provider=AWS", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "provider": "AWS" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d provider=AWS", + "generated": true + } + ] + } + } + ] + }, + "subpackage_cluster.CreateCluster": { + "id": "subpackage_cluster.CreateCluster", + "namespace": [ + "subpackage_cluster" + ], + "description": "Create a cluster in the Organization. An Astro cluster is a Kubernetes cluster that hosts the infrastructure required to run Deployments.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/clusters" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to create the cluster in." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateClusterRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Cluster" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/clusters", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "dbInstanceType": "Small General Purpose", + "name": "My cluster", + "nodePools": [ + { + "isDefault": true, + "maxNodeCount": 10, + "name": "my-nodepool", + "nodeInstanceType": "t3.medium" + } + ], + "providerAccount": "provider-account", + "region": "us-east-1", + "type": "DEDICATED", + "vpcSubnetRange": "172.20.0.0/22" + } + }, + "responseBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "createdAt": "2022-11-22T04:37:12Z", + "dbInstanceType": "db.t3.medium", + "id": "clm7k8tgw000008jz97i37y81", + "name": "my cluster", + "organizationId": "clm88r8hi000008jwhzxu5crg", + "region": "us-east-1", + "status": "CREATING", + "type": "DEDICATED", + "updatedAt": "2022-11-22T04:37:12Z", + "vpcSubnetRange": "172.20.0.0/22", + "isLimited": false, + "metadata": { + "externalIPs": [ + "externalIPs" + ], + "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/" + }, + "nodePools": [ + { + "cloudProvider": "AWS", + "clusterId": "clm891jb6000308jrc3vjdtde", + "createdAt": "2022-11-22T04:37:12Z", + "id": "clm890zhe000208jr39dd0ubs", + "isDefault": true, + "maxNodeCount": 1, + "name": "default", + "nodeInstanceType": "t3.medium", + "updatedAt": "2022-11-22T04:37:12Z", + "supportedAstroMachines": [ + "supportedAstroMachines" + ] + } + ], + "podSubnetRange": "172.21.0.0/19", + "providerAccount": "provider-account", + "servicePeeringRange": "172.23.0.0/20", + "serviceSubnetRange": "172.22.0.0/22", + "tags": [ + { + "key": "key1", + "value": "value1" + } + ], + "tenantId": "your-tenant-id", + "workspaceIds": [ + "workspaceIds" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cloudProvider\": \"AWS\",\n \"dbInstanceType\": \"Small General Purpose\",\n \"name\": \"My cluster\",\n \"nodePools\": [\n {\n \"isDefault\": true,\n \"maxNodeCount\": 10,\n \"name\": \"my-nodepool\",\n \"nodeInstanceType\": \"t3.medium\"\n }\n ],\n \"providerAccount\": \"provider-account\",\n \"region\": \"us-east-1\",\n \"type\": \"DEDICATED\",\n \"vpcSubnetRange\": \"172.20.0.0/22\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "name": "string", + "region": "string", + "type": "DEDICATED", + "vpcSubnetRange": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cloudProvider\": \"AWS\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"type\": \"DEDICATED\",\n \"vpcSubnetRange\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "name": "string", + "region": "string", + "type": "DEDICATED", + "vpcSubnetRange": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cloudProvider\": \"AWS\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"type\": \"DEDICATED\",\n \"vpcSubnetRange\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "name": "string", + "region": "string", + "type": "DEDICATED", + "vpcSubnetRange": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cloudProvider\": \"AWS\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"type\": \"DEDICATED\",\n \"vpcSubnetRange\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "name": "string", + "region": "string", + "type": "DEDICATED", + "vpcSubnetRange": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cloudProvider\": \"AWS\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"type\": \"DEDICATED\",\n \"vpcSubnetRange\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "name": "string", + "region": "string", + "type": "DEDICATED", + "vpcSubnetRange": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cloudProvider\": \"AWS\",\n \"name\": \"string\",\n \"region\": \"string\",\n \"type\": \"DEDICATED\",\n \"vpcSubnetRange\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_cluster.GetCluster": { + "id": "subpackage_cluster.GetCluster", + "namespace": [ + "subpackage_cluster" + ], + "description": "Retrieve details about a cluster.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/clusters/" + }, + { + "type": "pathParameter", + "value": "clusterId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the cluster belongs." + }, + { + "key": "clusterId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Cluster" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/clusters/clusterId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "clusterId": "clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "createdAt": "2022-11-22T04:37:12Z", + "dbInstanceType": "db.t3.medium", + "id": "clm7k8tgw000008jz97i37y81", + "name": "my cluster", + "organizationId": "clm88r8hi000008jwhzxu5crg", + "region": "us-east-1", + "status": "CREATING", + "type": "DEDICATED", + "updatedAt": "2022-11-22T04:37:12Z", + "vpcSubnetRange": "172.20.0.0/22", + "isLimited": false, + "metadata": { + "externalIPs": [ + "externalIPs" + ], + "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/" + }, + "nodePools": [ + { + "cloudProvider": "AWS", + "clusterId": "clm891jb6000308jrc3vjdtde", + "createdAt": "2022-11-22T04:37:12Z", + "id": "clm890zhe000208jr39dd0ubs", + "isDefault": true, + "maxNodeCount": 1, + "name": "default", + "nodeInstanceType": "t3.medium", + "updatedAt": "2022-11-22T04:37:12Z", + "supportedAstroMachines": [ + "supportedAstroMachines" + ] + } + ], + "podSubnetRange": "172.21.0.0/19", + "providerAccount": "provider-account", + "servicePeeringRange": "172.23.0.0/20", + "serviceSubnetRange": "172.22.0.0/22", + "tags": [ + { + "key": "key1", + "value": "value1" + } + ], + "tenantId": "your-tenant-id", + "workspaceIds": [ + "workspaceIds" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/clusters/clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_cluster.UpdateCluster": { + "id": "subpackage_cluster.UpdateCluster", + "namespace": [ + "subpackage_cluster" + ], + "description": "Update a cluster in the Organization.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/clusters/" + }, + { + "type": "pathParameter", + "value": "clusterId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the cluster belongs." + }, + { + "key": "clusterId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's ID" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UpdateClusterRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Cluster" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "clusterType": "DEDICATED", + "k8sTags": [ + {} + ], + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "cloudProvider": "AWS", + "createdAt": "2023-01-01T00:00:00Z", + "dbInstanceType": "string", + "id": "string", + "name": "string", + "organizationId": "string", + "region": "string", + "status": "CREATING", + "type": "DEDICATED", + "updatedAt": "2023-01-01T00:00:00Z", + "vpcSubnetRange": "string", + "isLimited": true, + "metadata": { + "externalIPs": [ + "string" + ], + "oidcIssuerUrl": "string" + }, + "nodePools": [ + { + "cloudProvider": "AWS", + "clusterId": "string", + "createdAt": "2023-01-01T00:00:00Z", + "id": "string", + "isDefault": true, + "maxNodeCount": 0, + "name": "string", + "nodeInstanceType": "string", + "updatedAt": "2023-01-01T00:00:00Z", + "supportedAstroMachines": [ + "string" + ] + } + ], + "podSubnetRange": "string", + "providerAccount": "string", + "servicePeeringRange": "string", + "serviceSubnetRange": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "tenantId": "string", + "workspaceIds": [ + "string" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"clusterType\": \"DEDICATED\",\n \"k8sTags\": [\n {}\n ],\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "clusterType": "DEDICATED", + "k8sTags": [ + {} + ], + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"clusterType\": \"DEDICATED\",\n \"k8sTags\": [\n {}\n ],\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "clusterType": "DEDICATED", + "k8sTags": [ + {} + ], + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"clusterType\": \"DEDICATED\",\n \"k8sTags\": [\n {}\n ],\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "clusterType": "DEDICATED", + "k8sTags": [ + {} + ], + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"clusterType\": \"DEDICATED\",\n \"k8sTags\": [\n {}\n ],\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "clusterType": "DEDICATED", + "k8sTags": [ + {} + ], + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"clusterType\": \"DEDICATED\",\n \"k8sTags\": [\n {}\n ],\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "clusterType": "DEDICATED", + "k8sTags": [ + {} + ], + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"clusterType\": \"DEDICATED\",\n \"k8sTags\": [\n {}\n ],\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_cluster.DeleteCluster": { + "id": "subpackage_cluster.DeleteCluster", + "namespace": [ + "subpackage_cluster" + ], + "description": "Delete a cluster.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/clusters/" + }, + { + "type": "pathParameter", + "value": "clusterId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the cluster belongs." + }, + { + "key": "clusterId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's ID." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/clusters/clusterId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "clusterId": "clusterId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/organizationId/clusters/clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/clusters/:clusterId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "clusterId": ":clusterId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/clusters/:clusterId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deployment.ListDeployments": { + "id": "subpackage_deployment.ListDeployments", + "namespace": [ + "subpackage_deployment" + ], + "description": "List Deployments in an Organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to list Deployments for." + } + ], + "queryParameters": [ + { + "key": "deploymentIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of IDs for Deployments to show. The API returns details only for the specified Deployments." + }, + { + "key": "names", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of names for Deployments to filter by. The API returns details only for the specified Deployments." + }, + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of IDs for Workspaces to filter on. The API returns details for all Deployments belonging only to the specified Workspaces." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results to skip before returning values." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to return." + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_deployment:ListDeploymentsRequestSortsItem" + } + }, + "description": "A list of field names to sort by, and whether to show results as ascending or descending. Formatted as `:asc` or `:desc`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DeploymentsPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "deployments": [ + { + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "id": "clmh57jtm000008lb58fe2wmv", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "name": "My deployment", + "namespace": "weightless-diameter-8927", + "organizationId": "clmh59gt0000308lbgswe5fvh", + "runtimeVersion": "9.1.0", + "schedulerCpu": "1", + "schedulerMemory": "1Gi", + "schedulerReplicas": 1, + "status": "CREATING", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1", + "webServerCpu": "0.5", + "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv", + "webServerMemory": "0.5Gi", + "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5", + "workspaceId": "clmh58o7d000108lb74ktc9o64", + "cloudProvider": "AWS", + "clusterId": "clmh597sg000208lb2kjhcn8q", + "clusterName": "my cluster", + "contactEmails": [ + "contactEmails" + ], + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "defaultTaskPodCpu": "0.5", + "defaultTaskPodMemory": "1Gi", + "description": "My deployment description", + "desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "environmentVariables": [ + { + "isSecret": true, + "key": "my-var", + "updatedAt": "2022-11-22T04:37:12Z", + "value": "my-var-value" + } + ], + "executor": "CELERY", + "externalIPs": [ + "externalIPs" + ], + "imageVersion": "deploy-2023-09-14T19-04", + "isDevelopmentMode": true, + "isHighAvailability": true, + "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/", + "region": "us-east-1", + "resourceQuotaCpu": "160", + "resourceQuotaMemory": "320Gi", + "schedulerAu": 5, + "schedulerSize": "SMALL", + "statusReason": "Successfully Deployed", + "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f", + "type": "DEDICATED", + "webServerReplicas": 1, + "workerQueues": [ + { + "id": "clmh9vsuf000908midngba9mw", + "isDefault": true, + "maxWorkerCount": 10, + "minWorkerCount": 1, + "name": "default", + "podCpu": "1", + "podMemory": "2Gi", + "workerConcurrency": 20, + "astroMachine": "A5", + "nodePoolId": "clmh9yjcn000a08mi8dsgbno9" + } + ], + "workloadIdentity": "workloadIdentity", + "workspaceName": "my-workspace" + } + ], + "limit": 10, + "offset": 0, + "totalCount": 100 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -d deploymentIds=string \\\n -d names=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -d deploymentIds=string \\\n -d names=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -d deploymentIds=string \\\n -d names=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "deploymentIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -d deploymentIds=string \\\n -d names=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deployment.CreateDeployment": { + "id": "subpackage_deployment.CreateDeployment", + "namespace": [ + "subpackage_deployment" + ], + "description": "Create a Deployment in the Organization. An Astro Deployment is an Airflow environment that is powered by all core Airflow components.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization in which to create the Deployment." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateDeploymentRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deployment" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "astroRuntimeVersion": "9.1.0", + "clusterId": "clmh9g6zj000008mg77if5wa2", + "defaultTaskPodCpu": "0.5", + "defaultTaskPodMemory": "1Gi", + "description": "My deployment description", + "environmentVariables": [ + { + "isSecret": false, + "key": "my-var", + "value": "my-var-value" + } + ], + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "My deployment", + "resourceQuotaCpu": "160", + "resourceQuotaMemory": "320Gi", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workerQueues": [ + { + "astroMachine": "A5", + "id": "clmha1mzc000b08mi96n182au", + "isDefault": true, + "maxWorkerCount": 1, + "minWorkerCount": 1, + "name": "My worker queue", + "workerConcurrency": 1 + } + ], + "workloadIdentity": "arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0", + "workspaceId": "clmh8ol3x000008jo656y4285" + } + }, + "responseBody": { + "type": "json", + "value": { + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "clmh57jtm000008lb58fe2wmv", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "name": "My deployment", + "namespace": "weightless-diameter-8927", + "organizationId": "clmh59gt0000308lbgswe5fvh", + "runtimeVersion": "9.1.0", + "schedulerCpu": "1", + "schedulerMemory": "1Gi", + "schedulerReplicas": 1, + "status": "CREATING", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1", + "webServerCpu": "0.5", + "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv", + "webServerMemory": "0.5Gi", + "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5", + "workspaceId": "clmh58o7d000108lb74ktc9o64", + "cloudProvider": "AWS", + "clusterId": "clmh597sg000208lb2kjhcn8q", + "clusterName": "my cluster", + "contactEmails": [ + "contactEmails" + ], + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "defaultTaskPodCpu": "0.5", + "defaultTaskPodMemory": "1Gi", + "description": "My deployment description", + "desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "environmentVariables": [ + { + "isSecret": true, + "key": "my-var", + "updatedAt": "2022-11-22T04:37:12Z", + "value": "my-var-value" + } + ], + "executor": "CELERY", + "externalIPs": [ + "externalIPs" + ], + "imageVersion": "deploy-2023-09-14T19-04", + "isDevelopmentMode": true, + "isHighAvailability": true, + "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/", + "region": "us-east-1", + "resourceQuotaCpu": "160", + "resourceQuotaMemory": "320Gi", + "scalingSpec": { + "hibernationSpec": { + "schedules": [ + { + "hibernateAtCron": "hibernateAtCron", + "isEnabled": true, + "wakeAtCron": "wakeAtCron" + } + ] + } + }, + "scalingStatus": { + "hibernationStatus": { + "isHibernating": true, + "nextEventAt": "nextEventAt", + "nextEventType": "HIBERNATE", + "reason": "reason" + } + }, + "schedulerAu": 5, + "schedulerSize": "SMALL", + "statusReason": "Successfully Deployed", + "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f", + "type": "DEDICATED", + "webServerReplicas": 1, + "workerQueues": [ + { + "id": "clmh9vsuf000908midngba9mw", + "isDefault": true, + "maxWorkerCount": 10, + "minWorkerCount": 1, + "name": "default", + "podCpu": "1", + "podMemory": "2Gi", + "workerConcurrency": 20, + "astroMachine": "A5", + "nodePoolId": "clmh9yjcn000a08mi8dsgbno9" + } + ], + "workloadIdentity": "workloadIdentity", + "workspaceName": "my-workspace" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"astroRuntimeVersion\": \"9.1.0\",\n \"clusterId\": \"clmh9g6zj000008mg77if5wa2\",\n \"defaultTaskPodCpu\": \"0.5\",\n \"defaultTaskPodMemory\": \"1Gi\",\n \"description\": \"My deployment description\",\n \"environmentVariables\": [\n {\n \"isSecret\": false,\n \"key\": \"my-var\",\n \"value\": \"my-var-value\"\n }\n ],\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"My deployment\",\n \"resourceQuotaCpu\": \"160\",\n \"resourceQuotaMemory\": \"320Gi\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workerQueues\": [\n {\n \"astroMachine\": \"A5\",\n \"id\": \"clmha1mzc000b08mi96n182au\",\n \"isDefault\": true,\n \"maxWorkerCount\": 1,\n \"minWorkerCount\": 1,\n \"name\": \"My worker queue\",\n \"workerConcurrency\": 1\n }\n ],\n \"workloadIdentity\": \"arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0\",\n \"workspaceId\": \"clmh8ol3x000008jo656y4285\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "astroRuntimeVersion": "string", + "clusterId": "string", + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"astroRuntimeVersion\": \"string\",\n \"clusterId\": \"string\",\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "astroRuntimeVersion": "string", + "clusterId": "string", + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"astroRuntimeVersion\": \"string\",\n \"clusterId\": \"string\",\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "astroRuntimeVersion": "string", + "clusterId": "string", + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"astroRuntimeVersion\": \"string\",\n \"clusterId\": \"string\",\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "astroRuntimeVersion": "string", + "clusterId": "string", + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"astroRuntimeVersion\": \"string\",\n \"clusterId\": \"string\",\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deployment.GetDeployment": { + "id": "subpackage_deployment.GetDeployment", + "namespace": [ + "subpackage_deployment" + ], + "description": "Retrieve details about a Deployment.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Deployment belongs." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deployment" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "clmh57jtm000008lb58fe2wmv", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "name": "My deployment", + "namespace": "weightless-diameter-8927", + "organizationId": "clmh59gt0000308lbgswe5fvh", + "runtimeVersion": "9.1.0", + "schedulerCpu": "1", + "schedulerMemory": "1Gi", + "schedulerReplicas": 1, + "status": "CREATING", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1", + "webServerCpu": "0.5", + "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv", + "webServerMemory": "0.5Gi", + "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5", + "workspaceId": "clmh58o7d000108lb74ktc9o64", + "cloudProvider": "AWS", + "clusterId": "clmh597sg000208lb2kjhcn8q", + "clusterName": "my cluster", + "contactEmails": [ + "contactEmails" + ], + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "defaultTaskPodCpu": "0.5", + "defaultTaskPodMemory": "1Gi", + "description": "My deployment description", + "desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "environmentVariables": [ + { + "isSecret": true, + "key": "my-var", + "updatedAt": "2022-11-22T04:37:12Z", + "value": "my-var-value" + } + ], + "executor": "CELERY", + "externalIPs": [ + "externalIPs" + ], + "imageVersion": "deploy-2023-09-14T19-04", + "isDevelopmentMode": true, + "isHighAvailability": true, + "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/", + "region": "us-east-1", + "resourceQuotaCpu": "160", + "resourceQuotaMemory": "320Gi", + "scalingSpec": { + "hibernationSpec": { + "schedules": [ + { + "hibernateAtCron": "hibernateAtCron", + "isEnabled": true, + "wakeAtCron": "wakeAtCron" + } + ] + } + }, + "scalingStatus": { + "hibernationStatus": { + "isHibernating": true, + "nextEventAt": "nextEventAt", + "nextEventType": "HIBERNATE", + "reason": "reason" + } + }, + "schedulerAu": 5, + "schedulerSize": "SMALL", + "statusReason": "Successfully Deployed", + "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f", + "type": "DEDICATED", + "webServerReplicas": 1, + "workerQueues": [ + { + "id": "clmh9vsuf000908midngba9mw", + "isDefault": true, + "maxWorkerCount": 10, + "minWorkerCount": 1, + "name": "default", + "podCpu": "1", + "podMemory": "2Gi", + "workerConcurrency": 20, + "astroMachine": "A5", + "nodePoolId": "clmh9yjcn000a08mi8dsgbno9" + } + ], + "workloadIdentity": "workloadIdentity", + "workspaceName": "my-workspace" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deployment.UpdateDeployment": { + "id": "subpackage_deployment.UpdateDeployment", + "namespace": [ + "subpackage_deployment" + ], + "description": "Update a Deployment in the Organization.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Deployment belongs." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UpdateDeploymentRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deployment" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "defaultTaskPodCpu": "0.5", + "defaultTaskPodMemory": "1Gi", + "description": "My deployment description", + "environmentVariables": [ + { + "isSecret": false, + "key": "my-var", + "value": "my-var-value" + } + ], + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "My deployment", + "resourceQuotaCpu": "160", + "resourceQuotaMemory": "320Gi", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workerQueues": [ + { + "astroMachine": "A5", + "id": "clmha1mzc000b08mi96n182au", + "isDefault": true, + "maxWorkerCount": 1, + "minWorkerCount": 1, + "name": "My worker queue", + "workerConcurrency": 1 + } + ], + "workloadIdentity": "arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0", + "workspaceId": "clmh7vdf4000008lhhlnk9t6o" + } + }, + "responseBody": { + "type": "json", + "value": { + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "clmh57jtm000008lb58fe2wmv", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "name": "My deployment", + "namespace": "weightless-diameter-8927", + "organizationId": "clmh59gt0000308lbgswe5fvh", + "runtimeVersion": "9.1.0", + "schedulerCpu": "1", + "schedulerMemory": "1Gi", + "schedulerReplicas": 1, + "status": "CREATING", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "webServerAirflowApiUrl": "myorganization.astronomer-dev.run/d8fe2wmv/api/v1", + "webServerCpu": "0.5", + "webServerIngressHostname": "clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv", + "webServerMemory": "0.5Gi", + "webServerUrl": "myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5", + "workspaceId": "clmh58o7d000108lb74ktc9o64", + "cloudProvider": "AWS", + "clusterId": "clmh597sg000208lb2kjhcn8q", + "clusterName": "my cluster", + "contactEmails": [ + "contactEmails" + ], + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "defaultTaskPodCpu": "0.5", + "defaultTaskPodMemory": "1Gi", + "description": "My deployment description", + "desiredDagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "environmentVariables": [ + { + "isSecret": true, + "key": "my-var", + "updatedAt": "2022-11-22T04:37:12Z", + "value": "my-var-value" + } + ], + "executor": "CELERY", + "externalIPs": [ + "externalIPs" + ], + "imageVersion": "deploy-2023-09-14T19-04", + "isDevelopmentMode": true, + "isHighAvailability": true, + "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/", + "region": "us-east-1", + "resourceQuotaCpu": "160", + "resourceQuotaMemory": "320Gi", + "scalingSpec": { + "hibernationSpec": { + "schedules": [ + { + "hibernateAtCron": "hibernateAtCron", + "isEnabled": true, + "wakeAtCron": "wakeAtCron" + } + ] + } + }, + "scalingStatus": { + "hibernationStatus": { + "isHibernating": true, + "nextEventAt": "nextEventAt", + "nextEventType": "HIBERNATE", + "reason": "reason" + } + }, + "schedulerAu": 5, + "schedulerSize": "SMALL", + "statusReason": "Successfully Deployed", + "taskPodNodePoolId": "clmh5mash000008mia6lnbs0f", + "type": "DEDICATED", + "webServerReplicas": 1, + "workerQueues": [ + { + "id": "clmh9vsuf000908midngba9mw", + "isDefault": true, + "maxWorkerCount": 10, + "minWorkerCount": 1, + "name": "default", + "podCpu": "1", + "podMemory": "2Gi", + "workerConcurrency": 20, + "astroMachine": "A5", + "nodePoolId": "clmh9yjcn000a08mi8dsgbno9" + } + ], + "workloadIdentity": "workloadIdentity", + "workspaceName": "my-workspace" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"defaultTaskPodCpu\": \"0.5\",\n \"defaultTaskPodMemory\": \"1Gi\",\n \"description\": \"My deployment description\",\n \"environmentVariables\": [\n {\n \"isSecret\": false,\n \"key\": \"my-var\",\n \"value\": \"my-var-value\"\n }\n ],\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"My deployment\",\n \"resourceQuotaCpu\": \"160\",\n \"resourceQuotaMemory\": \"320Gi\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workerQueues\": [\n {\n \"astroMachine\": \"A5\",\n \"id\": \"clmha1mzc000b08mi96n182au\",\n \"isDefault\": true,\n \"maxWorkerCount\": 1,\n \"minWorkerCount\": 1,\n \"name\": \"My worker queue\",\n \"workerConcurrency\": 1\n }\n ],\n \"workloadIdentity\": \"arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0\",\n \"workspaceId\": \"clmh7vdf4000008lhhlnk9t6o\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "environmentVariables": [ + { + "isSecret": true, + "key": "string" + } + ], + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"environmentVariables\": [\n {\n \"isSecret\": true,\n \"key\": \"string\"\n }\n ],\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "environmentVariables": [ + { + "isSecret": true, + "key": "string" + } + ], + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"environmentVariables\": [\n {\n \"isSecret\": true,\n \"key\": \"string\"\n }\n ],\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "environmentVariables": [ + { + "isSecret": true, + "key": "string" + } + ], + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"environmentVariables\": [\n {\n \"isSecret\": true,\n \"key\": \"string\"\n }\n ],\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "environmentVariables": [ + { + "isSecret": true, + "key": "string" + } + ], + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"environmentVariables\": [\n {\n \"isSecret\": true,\n \"key\": \"string\"\n }\n ],\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "defaultTaskPodCpu": "string", + "defaultTaskPodMemory": "string", + "environmentVariables": [ + { + "isSecret": true, + "key": "string" + } + ], + "executor": "CELERY", + "isCicdEnforced": true, + "isDagDeployEnabled": true, + "isHighAvailability": true, + "name": "string", + "resourceQuotaCpu": "string", + "resourceQuotaMemory": "string", + "schedulerSize": "SMALL", + "type": "DEDICATED", + "workspaceId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"defaultTaskPodCpu\": \"string\",\n \"defaultTaskPodMemory\": \"string\",\n \"environmentVariables\": [\n {\n \"isSecret\": true,\n \"key\": \"string\"\n }\n ],\n \"executor\": \"CELERY\",\n \"isCicdEnforced\": true,\n \"isDagDeployEnabled\": true,\n \"isHighAvailability\": true,\n \"name\": \"string\",\n \"resourceQuotaCpu\": \"string\",\n \"resourceQuotaMemory\": \"string\",\n \"schedulerSize\": \"SMALL\",\n \"type\": \"DEDICATED\",\n \"workspaceId\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deployment.DeleteDeployment": { + "id": "subpackage_deployment.DeleteDeployment", + "namespace": [ + "subpackage_deployment" + ], + "description": "Delete a Deployment from an Organization.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Deployment belongs." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deployment.UpdateDeploymentHibernationOverride": { + "id": "subpackage_deployment.UpdateDeploymentHibernationOverride", + "namespace": [ + "subpackage_deployment" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/hibernation-override" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization ID" + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment ID" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "isHibernating", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "The type of override to perform. Set this value to 'true' to have the Deployment hibernate regardless of its hibernation schedule. Set the value to 'false' to have the Deployment wake up regardless of its hibernation schedule. Use 'OverrideUntil' to define the length of the override." + }, + { + "key": "overrideUntil", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The end of the override time in UTC, formatted as 'YYYY-MM-DDTHH:MM:SSZ'. If this value isn't specified, the override persists until you end it through the Astro UI or another API call." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DeploymentHibernationOverride" + } + } + }, + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/hibernation-override", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "isHibernating": true + } + }, + "responseBody": { + "type": "json", + "value": { + "isActive": true, + "isHibernating": true, + "overrideUntil": "2024-01-15T09:30:00Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/hibernation-override \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"isHibernating\": true\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deployment.DeleteDeploymentHibernationOverride": { + "id": "subpackage_deployment.DeleteDeploymentHibernationOverride", + "namespace": [ + "subpackage_deployment" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/hibernation-override" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization ID" + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment ID" + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/hibernation-override", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/hibernation-override \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deploy.ListDeploys": { + "id": "subpackage_deploy.ListDeploys", + "namespace": [ + "subpackage_deploy" + ], + "description": "List deploys for a deployment", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/deploys" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Deployment belongs." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + } + ], + "queryParameters": [ + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results to skip before returning values." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to return." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DeploysPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/deploys", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "deploys": [ + { + "createdAt": "2022-11-22T04:37:12Z", + "deploymentId": "clmh57jtm000008lb58fe2wmv", + "id": "clvetru2w000201mowqwua63n", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isDagDeployEnabled": true, + "status": "INITIALIZED", + "type": "IMAGE_AND_DAG", + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv", + "description": "My deploy description", + "rollbackFromId": "clvcz1lrq000101oitxtp276e", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + } + } + ], + "limit": 1, + "offset": 1, + "totalCount": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deploy.CreateDeploy": { + "id": "subpackage_deploy.CreateDeploy", + "namespace": [ + "subpackage_deploy" + ], + "description": "Create a new Deploy. A Deploy represents an intent to deploy new DAG code to an Astro Deployment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/deploys" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization in which to create the Deployment." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's description." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_deploy:CreateDeployRequestType" + }, + "description": "The type of the deploy." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deploy" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/deploys", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "IMAGE_AND_DAG", + "description": "My deploy description" + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "deploymentId": "clmh57jtm000008lb58fe2wmv", + "id": "clvetru2w000201mowqwua63n", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isDagDeployEnabled": true, + "status": "INITIALIZED", + "type": "IMAGE_AND_DAG", + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv", + "description": "My deploy description", + "rollbackFromId": "clvcz1lrq000101oitxtp276e", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"IMAGE_AND_DAG\",\n \"description\": \"My deploy description\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "IMAGE_AND_DAG" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"IMAGE_AND_DAG\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "IMAGE_AND_DAG" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"IMAGE_AND_DAG\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "IMAGE_AND_DAG" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"IMAGE_AND_DAG\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "IMAGE_AND_DAG" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"IMAGE_AND_DAG\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "IMAGE_AND_DAG" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"IMAGE_AND_DAG\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deploy.GetDeploy": { + "id": "subpackage_deploy.GetDeploy", + "namespace": [ + "subpackage_deploy" + ], + "description": "Get a deploy for a deployment", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/deploys/" + }, + { + "type": "pathParameter", + "value": "deployId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization in which to create the Deployment." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + }, + { + "key": "deployId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deploy's ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deploy" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/deploys/deployId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId", + "deployId": "deployId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "deploymentId": "clmh57jtm000008lb58fe2wmv", + "id": "clvetru2w000201mowqwua63n", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isDagDeployEnabled": true, + "status": "INITIALIZED", + "type": "IMAGE_AND_DAG", + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv", + "description": "My deploy description", + "rollbackFromId": "clvcz1lrq000101oitxtp276e", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys/deployId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deploy.UpdateDeploy": { + "id": "subpackage_deploy.UpdateDeploy", + "namespace": [ + "subpackage_deploy" + ], + "description": "Update an existing Deploy. A Deploy represents an intent to deploy new DAG code to an Astro Deployment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/deploys/" + }, + { + "type": "pathParameter", + "value": "deployId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization in which to create the Deployment." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + }, + { + "key": "deployId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deploy's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's description." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deploy" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/deploys/deployId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId", + "deployId": "deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "description": "My deploy description" + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "deploymentId": "clmh57jtm000008lb58fe2wmv", + "id": "clvetru2w000201mowqwua63n", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isDagDeployEnabled": true, + "status": "INITIALIZED", + "type": "IMAGE_AND_DAG", + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv", + "description": "My deploy description", + "rollbackFromId": "clvcz1lrq000101oitxtp276e", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys/deployId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"description\": \"My deploy description\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deploy.FinalizeDeploy": { + "id": "subpackage_deploy.FinalizeDeploy", + "namespace": [ + "subpackage_deploy" + ], + "description": "Finalize deploy of a deployment", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/deploys/" + }, + { + "type": "pathParameter", + "value": "deployId" + }, + { + "type": "literal", + "value": "/finalize" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization in which to create the Deployment." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + }, + { + "key": "deployId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deploy's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "dagTarballVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's DAG tarball version, also known as the Bundle Version in the Astro UI. Required if DAG deploys are enabled on the Deployment, and deploy type is either IMAGE_AND_DAG or DAG_ONLY." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deploy" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/deploys/deployId/finalize", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId", + "deployId": "deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "deploymentId": "clmh57jtm000008lb58fe2wmv", + "id": "clvetru2w000201mowqwua63n", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isDagDeployEnabled": true, + "status": "INITIALIZED", + "type": "IMAGE_AND_DAG", + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv", + "description": "My deploy description", + "rollbackFromId": "clvcz1lrq000101oitxtp276e", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys/deployId/finalize \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/finalize \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_deploy.DeployRollback": { + "id": "subpackage_deploy.DeployRollback", + "namespace": [ + "subpackage_deploy" + ], + "description": "Deploy rollback of a deployment", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/deployments/" + }, + { + "type": "pathParameter", + "value": "deploymentId" + }, + { + "type": "literal", + "value": "/deploys/" + }, + { + "type": "pathParameter", + "value": "deployId" + }, + { + "type": "literal", + "value": "/rollback" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization in which to create the Deployment." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + }, + { + "key": "deployId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deploy's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Deploy" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/deployments/deploymentId/deploys/deployId/rollback", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "deploymentId": "deploymentId", + "deployId": "deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "deploymentId": "clmh57jtm000008lb58fe2wmv", + "id": "clvetru2w000201mowqwua63n", + "imageRepository": "https://my-image-repository", + "imageTag": "my-image-tag", + "isDagDeployEnabled": true, + "status": "INITIALIZED", + "type": "IMAGE_AND_DAG", + "airflowVersion": "2.7.2, if airflow version is not found, it will return NA", + "astroRuntimeVersion": "9.1.0", + "createdBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "dagTarballVersion": "2024-01-12T18:32:20.5898930Z", + "dagsUploadUrl": "https://astroproddagdeploy.windows.core.net/clmh59gt0000308lbgswe5fvh/clmh57jtm000008lb58fe2wmv", + "description": "My deploy description", + "rollbackFromId": "clvcz1lrq000101oitxtp276e", + "updatedAt": "2022-11-22T04:37:12Z", + "updatedBySubject": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/deploys/deployId/rollback \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "deploymentId": ":deploymentId", + "deployId": ":deployId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/deploys/:deployId/rollback \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_workspace.ListWorkspaces": { + "id": "subpackage_workspace.ListWorkspaces", + "namespace": [ + "subpackage_workspace" + ], + "description": "List Workspaces in an Organization", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/workspaces" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to list Workspaces for." + } + ], + "queryParameters": [ + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of IDs for specific Workspaces to list. The API will list information only for Workspaces which have been specified in this list." + }, + { + "key": "names", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of names for specific Workspaces to filter by. The API will list information only for Workspaces which have been specified in this list." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results to skip before returning values." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to return." + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_workspace:ListWorkspacesRequestSortsItem" + } + }, + "description": "A list of field names to sort by, and whether to show results as ascending or descending. Formatted as `:asc` or `:desc`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WorkspacesPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/workspaces", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "limit": 0, + "offset": 0, + "totalCount": 0, + "workspaces": [ + { + "cicdEnforcedDefault": true, + "createdAt": "2023-09-08T12:00:00Z", + "id": "clm8t5u4q000008jq4qoc3036", + "name": "My Workspace", + "organizationId": "clm8t5u4q000008jq4qoc3036", + "updatedAt": "2023-09-08T13:30:00Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "description": "This is a test workspace", + "organizationName": "My Organization", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -d workspaceIds=string \\\n -d names=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -d workspaceIds=string \\\n -d names=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -d workspaceIds=string \\\n -d names=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceIds": "string", + "names": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -d workspaceIds=string \\\n -d names=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_workspace.CreateWorkspace": { + "id": "subpackage_workspace.CreateWorkspace", + "namespace": [ + "subpackage_workspace" + ], + "description": "Create a Workspace.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/workspaces" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Workspace will belong." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cicdEnforcedDefault", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether new Deployments enforce CI/CD deploys by default." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Workspace's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's name." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Workspace" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/workspaces", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Workspace", + "cicdEnforcedDefault": true, + "description": "This is a test workspace" + } + }, + "responseBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "createdAt": "2023-09-08T12:00:00Z", + "id": "clm8t5u4q000008jq4qoc3036", + "name": "My Workspace", + "organizationId": "clm8t5u4q000008jq4qoc3036", + "updatedAt": "2023-09-08T13:30:00Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "description": "This is a test workspace", + "organizationName": "My Organization", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Workspace\",\n \"cicdEnforcedDefault\": true,\n \"description\": \"This is a test workspace\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_workspace.GetWorkspace": { + "id": "subpackage_workspace.GetWorkspace", + "namespace": [ + "subpackage_workspace" + ], + "description": "Get information about a Workspace.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/workspaces/" + }, + { + "type": "pathParameter", + "value": "workspaceId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Workspace belongs." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Workspace" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/workspaces/workspaceId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "workspaceId": "workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "createdAt": "2023-09-08T12:00:00Z", + "id": "clm8t5u4q000008jq4qoc3036", + "name": "My Workspace", + "organizationId": "clm8t5u4q000008jq4qoc3036", + "updatedAt": "2023-09-08T13:30:00Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "description": "This is a test workspace", + "organizationName": "My Organization", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces/workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_workspace.UpdateWorkspace": { + "id": "subpackage_workspace.UpdateWorkspace", + "namespace": [ + "subpackage_workspace" + ], + "description": "Update a Workspace.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/workspaces/" + }, + { + "type": "pathParameter", + "value": "workspaceId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Workspace belongs." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cicdEnforcedDefault", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether new Deployments enforce CI/CD deploys by default." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's name." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Workspace" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/workspaces/workspaceId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "workspaceId": "workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "description": "This is a test workspace", + "name": "My Workspace" + } + }, + "responseBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "createdAt": "2023-09-08T12:00:00Z", + "id": "clm8t5u4q000008jq4qoc3036", + "name": "My Workspace", + "organizationId": "clm8t5u4q000008jq4qoc3036", + "updatedAt": "2023-09-08T13:30:00Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "description": "This is a test workspace", + "organizationName": "My Organization", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces/workspaceId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cicdEnforcedDefault\": true,\n \"description\": \"This is a test workspace\",\n \"name\": \"My Workspace\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "description": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cicdEnforcedDefault\": true,\n \"description\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "description": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cicdEnforcedDefault\": true,\n \"description\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "description": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cicdEnforcedDefault\": true,\n \"description\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "description": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cicdEnforcedDefault\": true,\n \"description\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "cicdEnforcedDefault": true, + "description": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"cicdEnforcedDefault\": true,\n \"description\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_workspace.DeleteWorkspace": { + "id": "subpackage_workspace.DeleteWorkspace", + "namespace": [ + "subpackage_workspace" + ], + "description": "Delete a Workspace.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/workspaces/" + }, + { + "type": "pathParameter", + "value": "workspaceId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/platform/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Workspace belongs." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's ID." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/workspaces/workspaceId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "workspaceId": "workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces/workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/workspaces/:workspaceId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "workspaceId": ":workspaceId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/workspaces/:workspaceId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_organization:ListOrganizationsRequestSupportPlan": { + "name": "ListOrganizationsRequestSupportPlan", + "shape": { + "type": "enum", + "values": [ + { + "value": "TRIAL" + }, + { + "value": "BASIC" + }, + { + "value": "STANDARD" + }, + { + "value": "PREMIUM" + }, + { + "value": "BUSINESS_CRITICAL" + } + ] + } + }, + "type_organization:ListOrganizationsRequestProduct": { + "name": "ListOrganizationsRequestProduct", + "shape": { + "type": "enum", + "values": [ + { + "value": "HOSTED" + }, + { + "value": "HYBRID" + } + ] + } + }, + "type_organization:ListOrganizationsRequestSortsItem": { + "name": "ListOrganizationsRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "name:asc" + }, + { + "value": "name:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + } + ] + } + }, + "type_options:GetClusterOptionsRequestProvider": { + "name": "GetClusterOptionsRequestProvider", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_options:GetClusterOptionsRequestType": { + "name": "GetClusterOptionsRequestType", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + } + ] + } + }, + "type_options:GetDeploymentOptionsRequestDeploymentType": { + "name": "GetDeploymentOptionsRequestDeploymentType", + "shape": { + "type": "enum", + "values": [ + { + "value": "HYBRID" + }, + { + "value": "DEDICATED" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_options:GetDeploymentOptionsRequestExecutor": { + "name": "GetDeploymentOptionsRequestExecutor", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_options:GetDeploymentOptionsRequestCloudProvider": { + "name": "GetDeploymentOptionsRequestCloudProvider", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_cluster:ListClustersRequestProvider": { + "name": "ListClustersRequestProvider", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_cluster:ListClustersRequestSortsItem": { + "name": "ListClustersRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "name:asc" + }, + { + "value": "name:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + } + ] + } + }, + "type_deployment:ListDeploymentsRequestSortsItem": { + "name": "ListDeploymentsRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "name:asc" + }, + { + "value": "name:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + } + ] + } + }, + "type_deploy:CreateDeployRequestType": { + "name": "CreateDeployRequestType", + "description": "The type of the deploy.", + "shape": { + "type": "enum", + "values": [ + { + "value": "IMAGE_AND_DAG" + }, + { + "value": "IMAGE_ONLY" + }, + { + "value": "DAG_ONLY" + } + ] + } + }, + "type_workspace:ListWorkspacesRequestSortsItem": { + "name": "ListWorkspacesRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "name:asc" + }, + { + "value": "name:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + } + ] + } + }, + "type_:BasicSubjectProfileSubjectType": { + "name": "BasicSubjectProfileSubjectType", + "description": "The subject type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "USER" + }, + { + "value": "SERVICEKEY" + } + ] + } + }, + "type_:BasicSubjectProfile": { + "name": "BasicSubjectProfile", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "apiTokenName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The API token's name. Returned only when `SubjectType` is `SERVICEKEY`." + }, + { + "key": "avatarUrl", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL for the user's profile image. Returned only when `SubjectType` is `USER`." + }, + { + "key": "fullName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The subject's full name. Returned only when `SubjectType` is `USER`." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The subject's ID." + }, + { + "key": "subjectType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfileSubjectType" + } + }, + "description": "The subject type." + }, + { + "key": "username", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The subject's username. Returned only when `SubjectType` is `USER`." + } + ] + } + }, + "type_:ClusterCloudProvider": { + "name": "ClusterCloudProvider", + "description": "The name of the cluster's cloud provider.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:ClusterStatus": { + "name": "ClusterStatus", + "description": "The status of the cluster.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREATING" + }, + { + "value": "CREATED" + }, + { + "value": "CREATE_FAILED" + }, + { + "value": "UPDATE_FAILED" + }, + { + "value": "UPDATING" + } + ] + } + }, + "type_:ClusterType": { + "name": "ClusterType", + "description": "The type of the cluster.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + } + ] + } + }, + "type_:Cluster": { + "name": "Cluster", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cloudProvider", + "valueShape": { + "type": "id", + "id": "type_:ClusterCloudProvider" + }, + "description": "The name of the cluster's cloud provider." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the cluster was created in UTC. formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "dbInstanceType", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The type of database instance that is used for the cluster." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's ID." + }, + { + "key": "isLimited", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the cluster is limited." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ClusterMetadata" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's name." + }, + { + "key": "nodePools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:NodePool" + } + } + }, + "description": "The list of node pools that are created in the cluster." + }, + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization that the cluster belongs to." + }, + { + "key": "podSubnetRange", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The subnet range for Pods. For GCP clusters only." + }, + { + "key": "providerAccount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The provider account ID. For GCP clusters only." + }, + { + "key": "region", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The region in which the cluster is created." + }, + { + "key": "servicePeeringRange", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The service peering range. For GCP clusters only." + }, + { + "key": "serviceSubnetRange", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The service subnet range. For GCP clusters only." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:ClusterStatus" + }, + "description": "The status of the cluster." + }, + { + "key": "tags", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ClusterK8STag" + } + } + }, + "description": "The Kubernetes tags in the cluster. For AWS Hybrid clusters only." + }, + { + "key": "tenantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tenant ID. For Azure clusters only." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ClusterType" + }, + "description": "The type of the cluster." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the cluster was last updated in UTC. formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "vpcSubnetRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The VPC subnet range." + }, + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of Workspaces that are authorized to the cluster." + } + ] + } + }, + "type_:ClusterK8STag": { + "name": "ClusterK8STag", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tag's key." + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tag's value." + } + ] + } + }, + "type_:ClusterMetadata": { + "name": "ClusterMetadata", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalIPs", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "External IPs of the cluster." + }, + { + "key": "oidcIssuerUrl", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "OIDC issuer URL for the cluster" + } + ] + } + }, + "type_:ClusterOptionsProvider": { + "name": "ClusterOptionsProvider", + "description": "The cloud provider.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:ClusterOptions": { + "name": "ClusterOptions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "databaseInstances", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProviderInstanceType" + } + }, + "description": "The available database instances." + }, + { + "key": "defaultDatabaseInstance", + "valueShape": { + "type": "id", + "id": "type_:ProviderInstanceType" + } + }, + { + "key": "defaultNodeInstance", + "valueShape": { + "type": "id", + "id": "type_:ProviderInstanceType" + } + }, + { + "key": "defaultPodSubnetRange", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default pod subnet range." + }, + { + "key": "defaultRegion", + "valueShape": { + "type": "id", + "id": "type_:ProviderRegion" + } + }, + { + "key": "defaultServicePeeringRange", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default service peering range." + }, + { + "key": "defaultServiceSubnetRange", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default service subnet range." + }, + { + "key": "defaultVpcSubnetRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default VPC subnet range." + }, + { + "key": "nodeCountDefault", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The default number of nodes." + }, + { + "key": "nodeCountMax", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of nodes." + }, + { + "key": "nodeCountMin", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The minimum number of nodes." + }, + { + "key": "nodeInstances", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProviderInstanceType" + } + }, + "description": "The available node instances." + }, + { + "key": "provider", + "valueShape": { + "type": "id", + "id": "type_:ClusterOptionsProvider" + }, + "description": "The cloud provider." + }, + { + "key": "regions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProviderRegion" + } + }, + "description": "The available regions." + } + ] + } + }, + "type_:ClustersPaginated": { + "name": "ClustersPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clusters", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Cluster" + } + }, + "description": "The list of clusters in the current page." + }, + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of clusters in one page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the current page of clusters." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of clusters." + } + ] + } + }, + "type_:CreateAwsClusterRequestCloudProvider": { + "name": "CreateAwsClusterRequestCloudProvider", + "description": "The cluster's cloud provider.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:CreateAwsClusterRequestType": { + "name": "CreateAwsClusterRequestType", + "description": "The cluster's type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + } + ] + } + }, + "type_:CreateAwsClusterRequest": { + "name": "CreateAwsClusterRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cloudProvider", + "valueShape": { + "type": "id", + "id": "type_:CreateAwsClusterRequestCloudProvider" + }, + "description": "The cluster's cloud provider." + }, + { + "key": "dbInstanceType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of database instance that is used for the cluster. Required for Hybrid clusters." + }, + { + "key": "k8sTags", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ClusterK8STag" + } + } + }, + "description": "The Kubernetes tags in the cluster." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's name." + }, + { + "key": "nodePools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CreateNodePoolRequest" + } + } + }, + "description": "The list of node pools to create in the cluster." + }, + { + "key": "providerAccount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The provider account ID. Required for Hybrid clusters." + }, + { + "key": "region", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's region." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:CreateAwsClusterRequestType" + }, + "description": "The cluster's type." + }, + { + "key": "vpcSubnetRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The VPC subnet range." + }, + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of Workspaces that are authorized to the cluster." + } + ] + } + }, + "type_:CreateAzureClusterRequestCloudProvider": { + "name": "CreateAzureClusterRequestCloudProvider", + "description": "The cluster's cloud provider.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:CreateAzureClusterRequestType": { + "name": "CreateAzureClusterRequestType", + "description": "The cluster's type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + } + ] + } + }, + "type_:CreateAzureClusterRequest": { + "name": "CreateAzureClusterRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cloudProvider", + "valueShape": { + "type": "id", + "id": "type_:CreateAzureClusterRequestCloudProvider" + }, + "description": "The cluster's cloud provider." + }, + { + "key": "dbInstanceType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of database instance that is used for the cluster. Required for Hybrid clusters." + }, + { + "key": "k8sTags", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ClusterK8STag" + } + } + }, + "description": "The Kubernetes tags in the cluster." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's name." + }, + { + "key": "nodePools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CreateNodePoolRequest" + } + } + }, + "description": "The list of node pools to create in the cluster." + }, + { + "key": "providerAccount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The provider account ID. Required for Hybrid clusters." + }, + { + "key": "region", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's region." + }, + { + "key": "tenantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tenant ID. For Azure clusters only." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:CreateAzureClusterRequestType" + }, + "description": "The cluster's type." + }, + { + "key": "vpcSubnetRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The VPC subnet range." + }, + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of Workspaces that are authorized to the cluster." + } + ] + } + }, + "type_:CreateClusterRequest": { + "name": "CreateClusterRequest", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Create Aws Cluster Request", + "shape": { + "type": "id", + "id": "type_:CreateAwsClusterRequest" + } + }, + { + "displayName": "Create Azure Cluster Request", + "shape": { + "type": "id", + "id": "type_:CreateAzureClusterRequest" + } + }, + { + "displayName": "Create Gcp Cluster Request", + "shape": { + "type": "id", + "id": "type_:CreateGcpClusterRequest" + } + } + ] + } + }, + "type_:CreateDedicatedDeploymentRequestExecutor": { + "name": "CreateDedicatedDeploymentRequestExecutor", + "description": "The Deployment's executor type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_:CreateDedicatedDeploymentRequestSchedulerSize": { + "name": "CreateDedicatedDeploymentRequestSchedulerSize", + "description": "The size of the scheduler pod.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SMALL" + }, + { + "value": "MEDIUM" + }, + { + "value": "LARGE" + } + ] + } + }, + "type_:CreateDedicatedDeploymentRequestType": { + "name": "CreateDedicatedDeploymentRequestType", + "description": "The type of the Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_:CreateDedicatedDeploymentRequest": { + "name": "CreateDedicatedDeploymentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "astroRuntimeVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Deployment's Astro Runtime version." + }, + { + "key": "clusterId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the cluster where the Deployment will be created." + }, + { + "key": "contactEmails", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of contact emails for the Deployment." + }, + { + "key": "defaultTaskPodCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores." + }, + { + "key": "defaultTaskPodMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `DefaultTaskPodCpu`." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's description." + }, + { + "key": "environmentVariables", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentEnvironmentVariableRequest" + } + } + }, + "description": "List of environment variables to add to the Deployment." + }, + { + "key": "executor", + "valueShape": { + "type": "id", + "id": "type_:CreateDedicatedDeploymentRequestExecutor" + }, + "description": "The Deployment's executor type." + }, + { + "key": "isCicdEnforced", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment requires that all deploys are made through CI/CD." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment has DAG deploys enabled." + }, + { + "key": "isDevelopmentMode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, deployment will be able to use development-only features, such as hibernation, but will not have guaranteed uptime SLAs" + }, + { + "key": "isHighAvailability", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment is configured for high availability. If `true`, multiple scheduler pods will be online." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's name." + }, + { + "key": "resourceQuotaCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores." + }, + { + "key": "resourceQuotaMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `ResourceQuotaCpu`." + }, + { + "key": "scalingSpec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentScalingSpecRequest" + } + } + }, + { + "key": "schedulerSize", + "valueShape": { + "type": "id", + "id": "type_:CreateDedicatedDeploymentRequestSchedulerSize" + }, + "description": "The size of the scheduler pod." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:CreateDedicatedDeploymentRequestType" + }, + "description": "The type of the Deployment." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkerQueueRequest" + } + } + }, + "description": "The list of worker queues configured for the Deployment. Applies only when `Executor` is `CELERY`. At least 1 worker queue is needed. All Deployments need at least 1 worker queue called `default`." + }, + { + "key": "workloadIdentity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's workload identity." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the workspace to which the Deployment belongs." + } + ] + } + }, + "type_:CreateDeploymentRequest": { + "name": "CreateDeploymentRequest", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Create Dedicated Deployment Request", + "shape": { + "type": "id", + "id": "type_:CreateDedicatedDeploymentRequest" + } + }, + { + "displayName": "Create Hybrid Deployment Request", + "shape": { + "type": "id", + "id": "type_:CreateHybridDeploymentRequest" + } + }, + { + "displayName": "Create Standard Deployment Request", + "shape": { + "type": "id", + "id": "type_:CreateStandardDeploymentRequest" + } + } + ] + } + }, + "type_:CreateGcpClusterRequestCloudProvider": { + "name": "CreateGcpClusterRequestCloudProvider", + "description": "The cluster's cloud provider.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:CreateGcpClusterRequestType": { + "name": "CreateGcpClusterRequestType", + "description": "The cluster's type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + } + ] + } + }, + "type_:CreateGcpClusterRequest": { + "name": "CreateGcpClusterRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cloudProvider", + "valueShape": { + "type": "id", + "id": "type_:CreateGcpClusterRequestCloudProvider" + }, + "description": "The cluster's cloud provider." + }, + { + "key": "dbInstanceType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of database instance that is used for the cluster. Required for Hybrid clusters." + }, + { + "key": "k8sTags", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ClusterK8STag" + } + } + }, + "description": "The Kubernetes tags in the cluster." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's name." + }, + { + "key": "nodePools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CreateNodePoolRequest" + } + } + }, + "description": "The list of node pools to create in the cluster." + }, + { + "key": "podSubnetRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The subnet range for Pods. For GCP clusters only." + }, + { + "key": "providerAccount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The provider account ID. Required for Hybrid clusters." + }, + { + "key": "region", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's region." + }, + { + "key": "servicePeeringRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The service subnet range. For GCP clusters only." + }, + { + "key": "serviceSubnetRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The service peering range. For GCP clusters only." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:CreateGcpClusterRequestType" + }, + "description": "The cluster's type." + }, + { + "key": "vpcSubnetRange", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The VPC subnet range." + }, + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of Workspaces that are authorized to the cluster." + } + ] + } + }, + "type_:CreateHybridDeploymentRequestExecutor": { + "name": "CreateHybridDeploymentRequestExecutor", + "description": "The Deployment's executor type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_:CreateHybridDeploymentRequestType": { + "name": "CreateHybridDeploymentRequestType", + "description": "The type of the Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_:CreateHybridDeploymentRequest": { + "name": "CreateHybridDeploymentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "astroRuntimeVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Deployment's Astro Runtime version." + }, + { + "key": "clusterId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the cluster where the Deployment will be created." + }, + { + "key": "contactEmails", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of contact emails for the Deployment." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's description." + }, + { + "key": "environmentVariables", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentEnvironmentVariableRequest" + } + } + }, + "description": "List of environment variables to add to the Deployment." + }, + { + "key": "executor", + "valueShape": { + "type": "id", + "id": "type_:CreateHybridDeploymentRequestExecutor" + }, + "description": "The Deployment's executor type." + }, + { + "key": "isCicdEnforced", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment requires that all deploys are made through CI/CD." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment has DAG deploys enabled." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's name." + }, + { + "key": "scheduler", + "valueShape": { + "type": "id", + "id": "type_:DeploymentInstanceSpecRequest" + } + }, + { + "key": "taskPodNodePoolId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The node pool ID for the task pods. For `KUBERNETES` executor only." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:CreateHybridDeploymentRequestType" + }, + "description": "The type of the Deployment." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:HybridWorkerQueueRequest" + } + } + }, + "description": "The list of worker queues configured for the Deployment. Applies only when `Executor` is `CELERY`. At least 1 worker queue is needed. All Deployments need at least 1 worker queue called `default`." + }, + { + "key": "workloadIdentity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's workload identity." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the workspace to which the Deployment belongs." + } + ] + } + }, + "type_:CreateNodePoolRequest": { + "name": "CreateNodePoolRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "isDefault", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the node pool is the default node pool of the cluster." + }, + { + "key": "maxNodeCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of nodes that can be created in the node pool." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the node pool." + }, + { + "key": "nodeInstanceType", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The type of node instance that is used for the node pool." + } + ] + } + }, + "type_:CreateStandardDeploymentRequestCloudProvider": { + "name": "CreateStandardDeploymentRequestCloudProvider", + "description": "The cloud provider for the Deployment's cluster. Optional if `ClusterId` is specified.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:CreateStandardDeploymentRequestExecutor": { + "name": "CreateStandardDeploymentRequestExecutor", + "description": "The Deployment's executor type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_:CreateStandardDeploymentRequestSchedulerSize": { + "name": "CreateStandardDeploymentRequestSchedulerSize", + "description": "The size of the scheduler pod.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SMALL" + }, + { + "value": "MEDIUM" + }, + { + "value": "LARGE" + } + ] + } + }, + "type_:CreateStandardDeploymentRequestType": { + "name": "CreateStandardDeploymentRequestType", + "description": "The type of the Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_:CreateStandardDeploymentRequest": { + "name": "CreateStandardDeploymentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "astroRuntimeVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Deployment's Astro Runtime version." + }, + { + "key": "cloudProvider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CreateStandardDeploymentRequestCloudProvider" + } + }, + "description": "The cloud provider for the Deployment's cluster. Optional if `ClusterId` is specified." + }, + { + "key": "clusterId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the cluster to which the Deployment will be created in. Optional if cloud provider and region is specified." + }, + { + "key": "contactEmails", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of contact emails for the Deployment." + }, + { + "key": "defaultTaskPodCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores." + }, + { + "key": "defaultTaskPodMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `DefaultTaskPodCpu`." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's description." + }, + { + "key": "environmentVariables", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentEnvironmentVariableRequest" + } + } + }, + "description": "List of environment variables to add to the Deployment." + }, + { + "key": "executor", + "valueShape": { + "type": "id", + "id": "type_:CreateStandardDeploymentRequestExecutor" + }, + "description": "The Deployment's executor type." + }, + { + "key": "isCicdEnforced", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment requires that all deploys are made through CI/CD." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment has DAG deploys enabled." + }, + { + "key": "isDevelopmentMode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, deployment will be able to use development-only features, such as hibernation, but will not have guaranteed uptime SLAs" + }, + { + "key": "isHighAvailability", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment is configured for high availability. If `true`, multiple scheduler pods will be online." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's name." + }, + { + "key": "region", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The region to host the Deployment in. Optional if `ClusterId` is specified." + }, + { + "key": "resourceQuotaCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores." + }, + { + "key": "resourceQuotaMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `ResourceQuotaCpu`." + }, + { + "key": "scalingSpec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentScalingSpecRequest" + } + } + }, + { + "key": "schedulerSize", + "valueShape": { + "type": "id", + "id": "type_:CreateStandardDeploymentRequestSchedulerSize" + }, + "description": "The size of the scheduler pod." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:CreateStandardDeploymentRequestType" + }, + "description": "The type of the Deployment." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkerQueueRequest" + } + } + }, + "description": "The list of worker queues configured for the Deployment. Applies only when `Executor` is `CELERY`. At least 1 worker queue is needed. All Deployments need at least 1 worker queue called `default`." + }, + { + "key": "workloadIdentity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's workload identity." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the workspace to which the Deployment belongs." + } + ] + } + }, + "type_:DeployStatus": { + "name": "DeployStatus", + "description": "The status of the deploy.", + "shape": { + "type": "enum", + "values": [ + { + "value": "INITIALIZED" + }, + { + "value": "DEPLOYED" + }, + { + "value": "FAILED" + } + ] + } + }, + "type_:DeployType": { + "name": "DeployType", + "description": "The type of deploy.", + "shape": { + "type": "enum", + "values": [ + { + "value": "IMAGE_AND_DAG" + }, + { + "value": "IMAGE_ONLY" + }, + { + "value": "DAG_ONLY" + } + ] + } + }, + "type_:Deploy": { + "name": "Deploy", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "airflowVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's Airflow version." + }, + { + "key": "astroRuntimeVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's Astro Runtime version." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the deploy was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "createdBySubject", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + }, + { + "key": "dagTarballVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's DAG tarball version, also known as the Bundle Version in the Astro UI." + }, + { + "key": "dagsUploadUrl", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's upload URL to upload DAG bundles. Appears only if dag deploys are enabled on the Deployment." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The deploy's description." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The deploy's ID." + }, + { + "key": "imageRepository", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL of the deploy's image repository." + }, + { + "key": "imageTag", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The deploy's image tag. Appears only if specified in the most recent deploy." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the deploy was triggered on a Deployment with DAG deploys enabled." + }, + { + "key": "rollbackFromId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the deploy that you completed a rollback on. Appears only if a rollback has been performed." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:DeployStatus" + }, + "description": "The status of the deploy." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:DeployType" + }, + "description": "The type of deploy." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The time when the deploy was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "updatedBySubject", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + } + ] + } + }, + "type_:DeploymentCloudProvider": { + "name": "DeploymentCloudProvider", + "description": "The cloud provider of the cluster. Only for Standard Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:DeploymentExecutor": { + "name": "DeploymentExecutor", + "description": "The Deployment's executor type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_:DeploymentSchedulerSize": { + "name": "DeploymentSchedulerSize", + "description": "The Deployment's scheduler size.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SMALL" + }, + { + "value": "MEDIUM" + }, + { + "value": "LARGE" + } + ] + } + }, + "type_:DeploymentStatus": { + "name": "DeploymentStatus", + "description": "The status of the Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREATING" + }, + { + "value": "DEPLOYING" + }, + { + "value": "HEALTHY" + }, + { + "value": "UNHEALTHY" + }, + { + "value": "UNKNOWN" + }, + { + "value": "HIBERNATING" + } + ] + } + }, + "type_:DeploymentType": { + "name": "DeploymentType", + "description": "The type of cluster that the Deployment runs on.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_:Deployment": { + "name": "Deployment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "airflowVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's Airflow version." + }, + { + "key": "astroRuntimeVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's Astro Runtime version." + }, + { + "key": "cloudProvider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentCloudProvider" + } + }, + "description": "The cloud provider of the cluster. Only for Standard Deployment." + }, + { + "key": "clusterId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the cluster where the Deployment is hosted." + }, + { + "key": "clusterName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the cluster where the Deployment is hosted. Only for Dedicated and Hybrid Deployments." + }, + { + "key": "contactEmails", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of contact emails for the Deployment." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Deployment was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "createdBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + }, + { + "key": "dagTarballVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's current DAG tarball version, also known as the Bundle Version in the Astro UI. If no deploys are currently processing, this value should be the same as DesiredDagTarballVersion." + }, + { + "key": "defaultTaskPodCpu", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores." + }, + { + "key": "defaultTaskPodMemory", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi`. This value must always be twice the value of `DefaultTaskPodCpu`." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's description." + }, + { + "key": "desiredDagTarballVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's expected DAG tarball version after a currently processing deploy completes. This value is updated when a user triggers a DAG-only deploy to indicate that the Deployment is expecting a new DAG tarball version. If no deploys are currently processing, this value should be the same as DagTarballVersion." + }, + { + "key": "environmentVariables", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentEnvironmentVariable" + } + } + }, + "description": "The Deployment's environment variables. Secret values will be omitted from response." + }, + { + "key": "executor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentExecutor" + } + }, + "description": "The Deployment's executor type." + }, + { + "key": "externalIPs", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of the Deployment's external IPs." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's ID." + }, + { + "key": "imageRepository", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL of the Deployment's image repository." + }, + { + "key": "imageTag", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's custom image tag. Appears only if specified in the most recent deploy." + }, + { + "key": "imageVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A tag that Astronomer applies to the Deployment's Astro Runtime image during a deploy. It includes the date and time of the deploy." + }, + { + "key": "isCicdEnforced", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment requires that all deploys are made through CI/CD." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment has DAG deploys enabled." + }, + { + "key": "isDevelopmentMode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, deployment will be able to use development-only features, such as hibernation, but will not have guaranteed uptime SLAs" + }, + { + "key": "isHighAvailability", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Deployment has high availability (HA) enabled. If `true`, multiple scheduler Pods will run at once." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's name." + }, + { + "key": "namespace", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's namespace name in the Kubernetes cluster." + }, + { + "key": "oidcIssuerUrl", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "OIDC issuer URL of the deployment's cluster" + }, + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Deployment belongs." + }, + { + "key": "region", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The region of the cluster. Only for Dedicated and Hybrid Deployments." + }, + { + "key": "resourceQuotaCpu", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores." + }, + { + "key": "resourceQuotaMemory", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi`. This value must always be twice the value of `ResourceQuotaCpu`." + }, + { + "key": "runtimeVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Deprecated: runtimeVersion has been replaced with astroRuntimeVersion" + }, + { + "key": "scalingSpec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentScalingSpec" + } + } + }, + { + "key": "scalingStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentScalingStatus" + } + } + }, + { + "key": "schedulerAu", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of Astronomer units (AU) for the Deployment's scheduler. Applies only to Deployments hosted on Hybrid clusters." + }, + { + "key": "schedulerCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The CPU limit for the Deployment's scheduler. Specified in number of CPU cores." + }, + { + "key": "schedulerMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The memory limit for the Deployment's scheduler. Units in Gibibytes or `Gi`." + }, + { + "key": "schedulerReplicas", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of schedulers to use in the Deployment." + }, + { + "key": "schedulerSize", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentSchedulerSize" + } + }, + "description": "The Deployment's scheduler size." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:DeploymentStatus" + }, + "description": "The status of the Deployment." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A message that provides context for the Deployment's status." + }, + { + "key": "taskPodNodePoolId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The node pool ID for the task pod." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentType" + } + }, + "description": "The type of cluster that the Deployment runs on." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Deployment was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "updatedBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + }, + { + "key": "webServerAirflowApiUrl", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's webserver's base url to directly access the Airflow api." + }, + { + "key": "webServerCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The CPU limit for the Deployment's webserver. Units are in number of CPU cores." + }, + { + "key": "webServerIngressHostname", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's webserver's ingress hostname." + }, + { + "key": "webServerMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The memory limit for the Deployment's webserver. Units in Gibibytes or `Gi`." + }, + { + "key": "webServerReplicas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of webserver replicas." + }, + { + "key": "webServerUrl", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's webserver's url." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkerQueue" + } + } + }, + "description": "A list of the Deployment's worker queues." + }, + { + "key": "workloadIdentity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's workload identity." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Workspace to which the Deployment belongs." + }, + { + "key": "workspaceName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Workspace to which the Deployment belongs." + } + ] + } + }, + "type_:DeploymentEnvironmentVariable": { + "name": "DeploymentEnvironmentVariable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "isSecret", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the environment variable is a secret." + }, + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The environment variable key, used to call the value in code." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The time when the environment variable was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment variable value." + } + ] + } + }, + "type_:DeploymentEnvironmentVariableRequest": { + "name": "DeploymentEnvironmentVariableRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "isSecret", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the environment variable is a secret." + }, + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The environment variable key, used to call the value in code." + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment variable value." + } + ] + } + }, + "type_:DeploymentHibernationOverride": { + "name": "DeploymentHibernationOverride", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "isActive", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the override is currently active or not" + }, + { + "key": "isHibernating", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to go into hibernation or not via the override rule" + }, + { + "key": "overrideUntil", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Timestamp till the override on the hibernation schedule is in effect" + } + ] + } + }, + "type_:DeploymentHibernationOverrideRequest": { + "name": "DeploymentHibernationOverrideRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "isHibernating", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to go into hibernation or not via the override rule" + }, + { + "key": "overrideUntil", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Timestamp till the override on the hibernation schedule is in effect" + } + ] + } + }, + "type_:DeploymentHibernationSchedule": { + "name": "DeploymentHibernationSchedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A brief description of the schedule" + }, + { + "key": "hibernateAtCron", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A 5-part cron expression defining the times at which the deployment should hibernate" + }, + { + "key": "isEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Toggle this schedule on or off. If set to false, this schedule will have no effect on hibernation." + }, + { + "key": "wakeAtCron", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A 5-part cron expression definingh the times at which the deployment should wake from hibernation" + } + ] + } + }, + "type_:DeploymentHibernationSpec": { + "name": "DeploymentHibernationSpec", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "override", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentHibernationOverride" + } + } + }, + { + "key": "schedules", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentHibernationSchedule" + } + } + }, + "description": "The list of schedules for deployment hibernation" + } + ] + } + }, + "type_:DeploymentHibernationSpecRequest": { + "name": "DeploymentHibernationSpecRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "override", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentHibernationOverrideRequest" + } + } + }, + { + "key": "schedules", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentHibernationSchedule" + } + } + }, + "description": "The list of schedules for deployment hibernation" + } + ] + } + }, + "type_:DeploymentHibernationStatusNextEventType": { + "name": "DeploymentHibernationStatusNextEventType", + "description": "The type of the next scheduled event for the deployment. Either HIBERNATE or WAKE", + "shape": { + "type": "enum", + "values": [ + { + "value": "HIBERNATE" + }, + { + "value": "WAKE" + } + ] + } + }, + "type_:DeploymentHibernationStatus": { + "name": "DeploymentHibernationStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "isHibernating", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "If the deployment is currently in hibernating state or not" + }, + { + "key": "nextEventAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Timestamp of the next scheduled hibernation event for the deployment" + }, + { + "key": "nextEventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentHibernationStatusNextEventType" + } + }, + "description": "The type of the next scheduled event for the deployment. Either HIBERNATE or WAKE" + }, + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Reason for the current hibernation state of the deployment" + } + ] + } + }, + "type_:DeploymentInstanceSpecRequest": { + "name": "DeploymentInstanceSpecRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "au", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of Astro unit allocated to the Deployment pod. Minimum `5`, Maximum `24`." + }, + { + "key": "replicas", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of replicas the pod should have. Minimum `1`, Maximum `4`." + } + ] + } + }, + "type_:DeploymentOptions": { + "name": "DeploymentOptions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "executors", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The available executors." + }, + { + "key": "resourceQuotas", + "valueShape": { + "type": "id", + "id": "type_:ResourceQuotaOptions" + } + }, + { + "key": "runtimeReleases", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RuntimeRelease" + } + }, + "description": "The available Astro Runtime versions." + }, + { + "key": "schedulerMachines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SchedulerMachine" + } + }, + "description": "The available scheduler sizes." + }, + { + "key": "workerMachines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkerMachine" + } + }, + "description": "The available worker machine types." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "id", + "id": "type_:WorkerQueueOptions" + } + }, + { + "key": "workloadIdentityOptions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkloadIdentityOption" + } + } + }, + "description": "The available workload identity options." + } + ] + } + }, + "type_:DeploymentScalingSpec": { + "name": "DeploymentScalingSpec", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "hibernationSpec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentHibernationSpec" + } + } + } + ] + } + }, + "type_:DeploymentScalingSpecRequest": { + "name": "DeploymentScalingSpecRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "hibernationSpec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentHibernationSpecRequest" + } + } + } + ] + } + }, + "type_:DeploymentScalingStatus": { + "name": "DeploymentScalingStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "hibernationStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentHibernationStatus" + } + } + } + ] + } + }, + "type_:DeploymentsPaginated": { + "name": "DeploymentsPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deployments", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Deployment" + } + }, + "description": "A list of Deployments in the current page." + }, + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of Deployments in one page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the current page of Deployments." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Deployments." + } + ] + } + }, + "type_:DeploysPaginated": { + "name": "DeploysPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deploys", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Deploy" + } + }, + "description": "A list of deploys in the current page." + }, + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of deploys in one page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the current page of deploys." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of deploys." + } + ] + } + }, + "type_:Error": { + "name": "Error", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "requestId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "statusCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:HybridWorkerQueueRequest": { + "name": "HybridWorkerQueueRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The worker queue's ID. If not provided, a new worker queue will be created." + }, + { + "key": "isDefault", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the worker queue is the default worker queue on the Deployment." + }, + { + "key": "maxWorkerCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of workers that can run at once." + }, + { + "key": "minWorkerCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The minimum number of workers running at once." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The worker queue's name." + }, + { + "key": "nodePoolId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The node pool ID associated with the worker queue." + }, + { + "key": "workerConcurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of concurrent tasks that a worker Pod can run at a time." + } + ] + } + }, + "type_:MachineSpec": { + "name": "MachineSpec", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "concurrency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The maximum number of tasks that a given machine instance can run at once." + }, + { + "key": "cpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The CPU quantity. Units are in number of CPU cores." + }, + { + "key": "ephemeralStorage", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ephemeral storage quantity. Units in Gibibytes or `Gi`." + }, + { + "key": "memory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The memory quantity. Units in Gibibytes or `Gi`." + } + ] + } + }, + "type_:ManagedDomainStatus": { + "name": "ManagedDomainStatus", + "description": "Whether the managed domain has completed the verification process.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "VERIFIED" + } + ] + } + }, + "type_:ManagedDomain": { + "name": "ManagedDomain", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the domain was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "enforcedLogins", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of login types that are enforced for users belonging to the domain." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The managed domain's ID." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The managed domain's name/ URL." + }, + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the managed domain belongs." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:ManagedDomainStatus" + }, + "description": "Whether the managed domain has completed the verification process." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the domain was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + } + ] + } + }, + "type_:NodePoolCloudProvider": { + "name": "NodePoolCloudProvider", + "description": "The name of the cloud provider.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AWS" + }, + { + "value": "AZURE" + }, + { + "value": "GCP" + } + ] + } + }, + "type_:NodePool": { + "name": "NodePool", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cloudProvider", + "valueShape": { + "type": "id", + "id": "type_:NodePoolCloudProvider" + }, + "description": "The name of the cloud provider." + }, + { + "key": "clusterId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the cluster that the node pool belongs to." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the node pool was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The node pool's ID." + }, + { + "key": "isDefault", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the node pool is the default node pool of the cluster." + }, + { + "key": "maxNodeCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of nodes that can be created in the node pool." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the node pool." + }, + { + "key": "nodeInstanceType", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The type of node instance that is used for the node pool." + }, + { + "key": "supportedAstroMachines", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of supported Astro machines for the node pool. Returned only for Hosted dedicated clusters." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the node pool was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + } + ] + } + }, + "type_:OrganizationPaymentMethod": { + "name": "OrganizationPaymentMethod", + "description": "The Organization's payment method.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT_CARD" + }, + { + "value": "INVOICE" + }, + { + "value": "AWS_MARKETPLACE" + }, + { + "value": "AZURE_MARKETPLACE" + }, + { + "value": "GCP_MARKETPLACE" + } + ] + } + }, + "type_:OrganizationProduct": { + "name": "OrganizationProduct", + "description": "The Organization's product type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "HOSTED" + }, + { + "value": "HYBRID" + } + ] + } + }, + "type_:OrganizationStatus": { + "name": "OrganizationStatus", + "description": "The Organization's status.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ACTIVE" + }, + { + "value": "INACTIVE" + }, + { + "value": "SUSPENDED" + } + ] + } + }, + "type_:OrganizationSupportPlan": { + "name": "OrganizationSupportPlan", + "description": "The Organization's support plan.", + "shape": { + "type": "enum", + "values": [ + { + "value": "TRIAL" + }, + { + "value": "BASIC" + }, + { + "value": "STANDARD" + }, + { + "value": "PREMIUM" + }, + { + "value": "BUSINESS_CRITICAL" + } + ] + } + }, + "type_:Organization": { + "name": "Organization", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "billingEmail", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Organization's billing email." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Organization was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "createdBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's ID." + }, + { + "key": "isScimEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether SCIM is enabled for the Organization." + }, + { + "key": "managedDomains", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ManagedDomain" + } + } + }, + "description": "The list of managed domains configured in the Organization." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's name." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrganizationPaymentMethod" + } + }, + "description": "The Organization's payment method." + }, + { + "key": "product", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrganizationProduct" + } + }, + "description": "The Organization's product type." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrganizationStatus" + } + }, + "description": "The Organization's status." + }, + { + "key": "supportPlan", + "valueShape": { + "type": "id", + "id": "type_:OrganizationSupportPlan" + }, + "description": "The Organization's support plan." + }, + { + "key": "trialExpiresAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The time when the Organization's trial expires in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. Organizations that are no longer in Trial will not have a expiry date." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Organization was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "updatedBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + ] + } + }, + "type_:OrganizationsPaginated": { + "name": "OrganizationsPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of Organizations in the page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the Organizations in the page." + }, + { + "key": "organizations", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Organization" + } + }, + "description": "The list of Organizations in the page." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Organizations." + } + ] + } + }, + "type_:ProviderInstanceType": { + "name": "ProviderInstanceType", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of CPUs. Units are in number of CPU cores." + }, + { + "key": "memory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The amount of memory. Units in Gibibytes or `Gi`." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the instance type." + } + ] + } + }, + "type_:ProviderRegion": { + "name": "ProviderRegion", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bannedInstances", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The banned instances in the region." + }, + { + "key": "limited", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the region is limited." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the region." + } + ] + } + }, + "type_:Range": { + "name": "Range", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ceiling", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The maximum value." + }, + { + "key": "default", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The default value." + }, + { + "key": "floor", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The minimum value." + } + ] + } + }, + "type_:ResourceOption": { + "name": "ResourceOption", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cpu", + "valueShape": { + "type": "id", + "id": "type_:ResourceRange" + } + }, + { + "key": "memory", + "valueShape": { + "type": "id", + "id": "type_:ResourceRange" + } + } + ] + } + }, + "type_:ResourceQuotaOptions": { + "name": "ResourceQuotaOptions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "defaultPodSize", + "valueShape": { + "type": "id", + "id": "type_:ResourceOption" + } + }, + { + "key": "resourceQuota", + "valueShape": { + "type": "id", + "id": "type_:ResourceOption" + } + } + ] + } + }, + "type_:ResourceRange": { + "name": "ResourceRange", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ceiling", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The maximum value." + }, + { + "key": "default", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default value." + }, + { + "key": "floor", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The minimum value." + } + ] + } + }, + "type_:RuntimeRelease": { + "name": "RuntimeRelease", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "airflowDatabaseMigration", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the release requires an Airflow database migration." + }, + { + "key": "airflowVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Airflow version that the Runtime image is based on." + }, + { + "key": "channel", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The release channel." + }, + { + "key": "releaseDate", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the version is released in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "stellarDatabaseMigration", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the release requires a Stellar database migration." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Astro Runtime version." + } + ] + } + }, + "type_:SchedulerMachineName": { + "name": "SchedulerMachineName", + "description": "The machine's name.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SMALL" + }, + { + "value": "MEDIUM" + }, + { + "value": "LARGE" + } + ] + } + }, + "type_:SchedulerMachine": { + "name": "SchedulerMachine", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:SchedulerMachineName" + }, + "description": "The machine's name." + }, + { + "key": "spec", + "valueShape": { + "type": "id", + "id": "type_:MachineSpec" + } + } + ] + } + }, + "type_:UpdateClusterRequest": { + "name": "UpdateClusterRequest", + "shape": { + "type": "discriminatedUnion", + "discriminant": "clusterType", + "variants": [ + { + "discriminantValue": "DEDICATED", + "extends": [ + "type_:UpdateDedicatedClusterRequest" + ], + "properties": [] + }, + { + "discriminantValue": "HYBRID", + "extends": [ + "type_:UpdateHybridClusterRequest" + ], + "properties": [] + } + ] + } + }, + "type_:UpdateDedicatedClusterRequest": { + "name": "UpdateDedicatedClusterRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "dbInstanceType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The cluster's database instance type. Required for Hybrid clusters." + }, + { + "key": "k8sTags", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ClusterK8STag" + } + }, + "description": "A list of Kubernetes tags to add to the cluster." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The cluster's name." + }, + { + "key": "nodePools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:UpdateNodePoolRequest" + } + } + }, + "description": "A list of node pools to add to the cluster. For Hybrid clusters only." + }, + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of Workspaces that are authorized to the cluster. If this value is not provided, the existing list of Workspaces remains. If this value is '[]' then all workspace cluster mappings are removed." + } + ] + } + }, + "type_:UpdateDedicatedDeploymentRequestExecutor": { + "name": "UpdateDedicatedDeploymentRequestExecutor", + "description": "The executor Deployment's executor.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_:UpdateDedicatedDeploymentRequestSchedulerSize": { + "name": "UpdateDedicatedDeploymentRequestSchedulerSize", + "description": "The size of the scheduler pod.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SMALL" + }, + { + "value": "MEDIUM" + }, + { + "value": "LARGE" + } + ] + } + }, + "type_:UpdateDedicatedDeploymentRequestType": { + "name": "UpdateDedicatedDeploymentRequestType", + "description": "The type of the Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_:UpdateDedicatedDeploymentRequest": { + "name": "UpdateDedicatedDeploymentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "contactEmails", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of contact emails for the Deployment." + }, + { + "key": "defaultTaskPodCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores." + }, + { + "key": "defaultTaskPodMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `DefaultTaskPodCpu`." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's description." + }, + { + "key": "environmentVariables", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentEnvironmentVariableRequest" + } + }, + "description": "List of environment variables to add to the Deployment." + }, + { + "key": "executor", + "valueShape": { + "type": "id", + "id": "type_:UpdateDedicatedDeploymentRequestExecutor" + }, + "description": "The executor Deployment's executor." + }, + { + "key": "isCicdEnforced", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment requires that all deploys are made through CI/CD." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment has DAG deploys enabled." + }, + { + "key": "isDevelopmentMode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Deployment is for development only. If `false`, the Deployment can be considered production for the purposes of support case priority, but development-only features such as hibernation will not be available. You can't update this value to `true` for existing non-development Deployments." + }, + { + "key": "isHighAvailability", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment is configured for high availability. If `true`, multiple scheduler pods will be online." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's name." + }, + { + "key": "resourceQuotaCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores." + }, + { + "key": "resourceQuotaMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `ResourceQuotaCpu`." + }, + { + "key": "scalingSpec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentScalingSpecRequest" + } + } + }, + { + "key": "schedulerSize", + "valueShape": { + "type": "id", + "id": "type_:UpdateDedicatedDeploymentRequestSchedulerSize" + }, + "description": "The size of the scheduler pod." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:UpdateDedicatedDeploymentRequestType" + }, + "description": "The type of the Deployment." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkerQueueRequest" + } + } + }, + "description": "A list of the Deployment's worker queues. Applies only when `Executor` is `CELERY`. All Deployments need at least 1 worker queue called `default`." + }, + { + "key": "workloadIdentity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's workload identity." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Workspace to which the Deployment belongs." + } + ] + } + }, + "type_:UpdateDeploymentRequest": { + "name": "UpdateDeploymentRequest", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Update Dedicated Deployment Request", + "shape": { + "type": "id", + "id": "type_:UpdateDedicatedDeploymentRequest" + } + }, + { + "displayName": "Update Hybrid Deployment Request", + "shape": { + "type": "id", + "id": "type_:UpdateHybridDeploymentRequest" + } + }, + { + "displayName": "Update Standard Deployment Request", + "shape": { + "type": "id", + "id": "type_:UpdateStandardDeploymentRequest" + } + } + ] + } + }, + "type_:UpdateHybridClusterRequest": { + "name": "UpdateHybridClusterRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "workspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of Workspaces that are authorized to the cluster. If this value is not provided, the existing list of Workspaces remains. If this value is '[]' then all workspace cluster mappings are removed." + } + ] + } + }, + "type_:UpdateHybridDeploymentRequestExecutor": { + "name": "UpdateHybridDeploymentRequestExecutor", + "description": "The Deployment's executor type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_:UpdateHybridDeploymentRequestType": { + "name": "UpdateHybridDeploymentRequestType", + "description": "The type of the Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_:UpdateHybridDeploymentRequest": { + "name": "UpdateHybridDeploymentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "contactEmails", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of contact emails for the Deployment." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's description." + }, + { + "key": "environmentVariables", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentEnvironmentVariableRequest" + } + }, + "description": "List of environment variables to add to the Deployment." + }, + { + "key": "executor", + "valueShape": { + "type": "id", + "id": "type_:UpdateHybridDeploymentRequestExecutor" + }, + "description": "The Deployment's executor type." + }, + { + "key": "isCicdEnforced", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment requires that all deploys are made through CI/CD." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment has DAG deploys enabled." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's name." + }, + { + "key": "scheduler", + "valueShape": { + "type": "id", + "id": "type_:DeploymentInstanceSpecRequest" + } + }, + { + "key": "taskPodNodePoolId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The node pool ID for worker Pods. Applies only when `Executor` is `KUBERNETES`." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:UpdateHybridDeploymentRequestType" + }, + "description": "The type of the Deployment." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:HybridWorkerQueueRequest" + } + } + }, + "description": "The list of worker queues configured for the Deployment. Applies only when `Executor` is `CELERY`. All Deployments need at least 1 worker queue called `default`." + }, + { + "key": "workloadIdentity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's workload identity." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Workspace to which the Deployment belongs." + } + ] + } + }, + "type_:UpdateNodePoolRequest": { + "name": "UpdateNodePoolRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The node pool's ID." + }, + { + "key": "isDefault", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the node pool is the default node pool of the cluster." + }, + { + "key": "maxNodeCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of nodes that can be created in the node pool." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the node pool." + }, + { + "key": "nodeInstanceType", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The type of node instance that is used for the node pool." + } + ] + } + }, + "type_:UpdateStandardDeploymentRequestExecutor": { + "name": "UpdateStandardDeploymentRequestExecutor", + "description": "The executor Deployment's executor.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CELERY" + }, + { + "value": "KUBERNETES" + } + ] + } + }, + "type_:UpdateStandardDeploymentRequestSchedulerSize": { + "name": "UpdateStandardDeploymentRequestSchedulerSize", + "description": "The size of the scheduler pod.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SMALL" + }, + { + "value": "MEDIUM" + }, + { + "value": "LARGE" + } + ] + } + }, + "type_:UpdateStandardDeploymentRequestType": { + "name": "UpdateStandardDeploymentRequestType", + "description": "The type of the Deployment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEDICATED" + }, + { + "value": "HYBRID" + }, + { + "value": "STANDARD" + } + ] + } + }, + "type_:UpdateStandardDeploymentRequest": { + "name": "UpdateStandardDeploymentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "contactEmails", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of contact emails for the Deployment." + }, + { + "key": "defaultTaskPodCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores." + }, + { + "key": "defaultTaskPodMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `DefaultTaskPodCpu`." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's description." + }, + { + "key": "environmentVariables", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentEnvironmentVariableRequest" + } + }, + "description": "List of environment variables to add to the Deployment." + }, + { + "key": "executor", + "valueShape": { + "type": "id", + "id": "type_:UpdateStandardDeploymentRequestExecutor" + }, + "description": "The executor Deployment's executor." + }, + { + "key": "isCicdEnforced", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment requires that all deploys are made through CI/CD." + }, + { + "key": "isDagDeployEnabled", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment has DAG deploys enabled." + }, + { + "key": "isDevelopmentMode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Deployment is for development only. If `false`, the Deployment can be considered production for the purposes of support case priority, but development-only features such as hibernation will not be available. You can't update this value to `true` for existing non-development Deployments." + }, + { + "key": "isHighAvailability", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Deployment is configured for high availability. If `true`, multiple scheduler pods will be online." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment's name." + }, + { + "key": "resourceQuotaCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores." + }, + { + "key": "resourceQuotaMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `ResourceQuotaCpu`." + }, + { + "key": "scalingSpec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeploymentScalingSpecRequest" + } + } + }, + { + "key": "schedulerSize", + "valueShape": { + "type": "id", + "id": "type_:UpdateStandardDeploymentRequestSchedulerSize" + }, + "description": "The size of the scheduler pod." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:UpdateStandardDeploymentRequestType" + }, + "description": "The type of the Deployment." + }, + { + "key": "workerQueues", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkerQueueRequest" + } + } + }, + "description": "A list of the Deployment's worker queues. Applies only when `Executor` is `CELERY`. All Deployments need at least 1 worker queue called `default`." + }, + { + "key": "workloadIdentity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Deployment's workload identity." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Workspace to which the Deployment belongs." + } + ] + } + }, + "type_:WorkerMachineName": { + "name": "WorkerMachineName", + "description": "The machine's name.", + "shape": { + "type": "enum", + "values": [ + { + "value": "A5" + }, + { + "value": "A10" + }, + { + "value": "A20" + }, + { + "value": "A40" + }, + { + "value": "A60" + }, + { + "value": "A120" + }, + { + "value": "A160" + } + ] + } + }, + "type_:WorkerMachine": { + "name": "WorkerMachine", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "concurrency", + "valueShape": { + "type": "id", + "id": "type_:Range" + } + }, + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:WorkerMachineName" + }, + "description": "The machine's name." + }, + { + "key": "spec", + "valueShape": { + "type": "id", + "id": "type_:MachineSpec" + } + } + ] + } + }, + "type_:WorkerQueue": { + "name": "WorkerQueue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "astroMachine", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Astro machine size for each worker node in the queue. For Astro Hosted only." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The worker queue's ID." + }, + { + "key": "isDefault", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the worker queue is the default worker queue in the Deployment." + }, + { + "key": "maxWorkerCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of workers that can run at once." + }, + { + "key": "minWorkerCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The minimum number of workers running at once." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The worker queue's name." + }, + { + "key": "nodePoolId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The node pool ID associated with the worker queue." + }, + { + "key": "podCpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The maximum number of CPU units available for a worker node. Units are in number of CPU cores." + }, + { + "key": "podMemory", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The maximum amount of memory available for a worker node. Units are in Gibibytes or `Gi`." + }, + { + "key": "workerConcurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of concurrent tasks that a worker Pod can run at a time." + } + ] + } + }, + "type_:WorkerQueueOptions": { + "name": "WorkerQueueOptions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "maxWorkers", + "valueShape": { + "type": "id", + "id": "type_:Range" + } + }, + { + "key": "minWorkers", + "valueShape": { + "type": "id", + "id": "type_:Range" + } + }, + { + "key": "workerConcurrency", + "valueShape": { + "type": "id", + "id": "type_:Range" + } + } + ] + } + }, + "type_:WorkerQueueRequestAstroMachine": { + "name": "WorkerQueueRequestAstroMachine", + "description": "The Astro machine for each worker in the queue. For Astro Hosted only.", + "shape": { + "type": "enum", + "values": [ + { + "value": "A5" + }, + { + "value": "A10" + }, + { + "value": "A20" + }, + { + "value": "A40" + }, + { + "value": "A60" + }, + { + "value": "A120" + }, + { + "value": "A160" + } + ] + } + }, + "type_:WorkerQueueRequest": { + "name": "WorkerQueueRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "astroMachine", + "valueShape": { + "type": "id", + "id": "type_:WorkerQueueRequestAstroMachine" + }, + "description": "The Astro machine for each worker in the queue. For Astro Hosted only." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The worker queue's ID. If not provided, a new worker queue will be created." + }, + { + "key": "isDefault", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the worker queue is the default worker queue on the Deployment." + }, + { + "key": "maxWorkerCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of workers that can run at once." + }, + { + "key": "minWorkerCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The minimum number of workers running at once." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The worker queue's name." + }, + { + "key": "workerConcurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of concurrent tasks that a worker Pod can run at a time." + } + ] + } + }, + "type_:WorkloadIdentityOption": { + "name": "WorkloadIdentityOption", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "label", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The workload identity label." + }, + { + "key": "role", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The workload identity role." + } + ] + } + }, + "type_:Workspace": { + "name": "Workspace", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cicdEnforcedDefault", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether CI/CD deploys are enforced by default." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Workspace was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`" + }, + { + "key": "createdBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Workspace's description." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's ID." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace's name." + }, + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the organization to which the workspace belongs." + }, + { + "key": "organizationName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Organization to which the Workspace belongs." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Workspace was updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`" + }, + { + "key": "updatedBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + } + ] + } + }, + "type_:WorkspacesPaginated": { + "name": "WorkspacesPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of workspaces that can be retrieved per page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset for the current page of workspaces in the complete result." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Workspaces in the paginated result." + }, + { + "key": "workspaces", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Workspace" + } + }, + "description": "An array of Workspace objects representing a list of workspaces." + } + ] + } + } + }, + "subpackages": { + "subpackage_organization": { + "id": "subpackage_organization", + "name": "Organization", + "displayName": "Organization" + }, + "subpackage_options": { + "id": "subpackage_options", + "name": "Options", + "displayName": "Options" + }, + "subpackage_cluster": { + "id": "subpackage_cluster", + "name": "Cluster", + "displayName": "Cluster" + }, + "subpackage_deployment": { + "id": "subpackage_deployment", + "name": "deployment" + }, + "subpackage_deploy": { + "id": "subpackage_deploy", + "name": "deploy" + }, + "subpackage_workspace": { + "id": "subpackage_workspace", + "name": "Workspace", + "displayName": "Workspace" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "token" + } + } + }, + { + "id": "a4030141-9ea5-4ac9-8d2b-f44b815980a8", + "endpoints": { + "subpackage_authorization.ListPermissionGroups": { + "id": "subpackage_authorization.ListPermissionGroups", + "namespace": [ + "subpackage_authorization" + ], + "description": "List the available permissions you can grant to a custom role.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/authorization/permission-groups" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "queryParameters": [ + { + "key": "scopeType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_authorization:ListPermissionGroupsRequestScopeType" + } + }, + "description": "Filter the returned permissions based on the scope they apply to. Note that currently, the only available permissions are in the `DEPLOYMENT` scope." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PermissionGroup" + } + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/authorization/permission-groups", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "description": "Astro notification channel defines where alert messages can be sent. For example, alert messages issued via email or slack.", + "name": "workspace.notificationChannels", + "permissions": [ + { + "action": "get", + "description": "Subject is permitted to get the scope." + } + ], + "scope": "Workspace NotificationChannels" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/authorization/permission-groups \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/authorization/permission-groups", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "scopeType": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/authorization/permission-groups \\\n -H \"Authorization: Bearer \" \\\n -d scopeType=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/authorization/permission-groups", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "scopeType": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/authorization/permission-groups \\\n -H \"Authorization: Bearer \" \\\n -d scopeType=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/authorization/permission-groups", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": { + "scopeType": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/authorization/permission-groups \\\n -H \"Authorization: Bearer \" \\\n -d scopeType=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/authorization/permission-groups", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "scopeType": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/authorization/permission-groups \\\n -H \"Authorization: Bearer \" \\\n -d scopeType=DEPLOYMENT", + "generated": true + } + ] + } + } + ] + }, + "subpackage_invite.CreateUserInvite": { + "id": "subpackage_invite.CreateUserInvite", + "namespace": [ + "subpackage_invite" + ], + "description": "Invite a user to an Organization.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/invites" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to invite the user to." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "inviteeEmail", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The email of the user to invite." + }, + { + "key": "role", + "valueShape": { + "type": "id", + "id": "type_invite:CreateUserInviteRequestRole" + }, + "description": "The user's Organization role." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Invite" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/invites", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "inviteeEmail": "user1@company.com", + "role": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "expiresAt": "2022-11-22T04:37:12Z", + "inviteId": "clm9t1g17000008jmfsw20lsz", + "invitee": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "inviter": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "organizationId": "clm9t0gbt000108jv4f1cfu8u", + "organizationName": "My Organization", + "userId": "clm9t060z000008jv3mira7x5" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/invites \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"inviteeEmail\": \"user1@company.com\",\n \"role\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "inviteeEmail": "string", + "role": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"inviteeEmail\": \"string\",\n \"role\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "inviteeEmail": "string", + "role": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"inviteeEmail\": \"string\",\n \"role\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "inviteeEmail": "string", + "role": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"inviteeEmail\": \"string\",\n \"role\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "inviteeEmail": "string", + "role": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"inviteeEmail\": \"string\",\n \"role\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "inviteeEmail": "string", + "role": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"inviteeEmail\": \"string\",\n \"role\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_invite.DeleteUserInvite": { + "id": "subpackage_invite.DeleteUserInvite", + "namespace": [ + "subpackage_invite" + ], + "description": "Delete an existing user invite.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/invites/" + }, + { + "type": "pathParameter", + "value": "inviteId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where the user was invited to." + }, + { + "key": "inviteId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The invite's ID." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/invites/inviteId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "inviteId": "inviteId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/organizationId/invites/inviteId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites/:inviteId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "inviteId": ":inviteId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites/:inviteId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites/:inviteId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "inviteId": ":inviteId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites/:inviteId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites/:inviteId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "inviteId": ":inviteId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites/:inviteId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites/:inviteId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "inviteId": ":inviteId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites/:inviteId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/invites/:inviteId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "inviteId": ":inviteId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/invites/:inviteId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_role.ListRoleTemplates": { + "id": "subpackage_role.ListRoleTemplates", + "namespace": [ + "subpackage_role" + ], + "description": "Get a list of available role templates in an Organization. A role template can be used as the basis for creating a new custom role.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/role-templates" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's ID." + } + ], + "queryParameters": [ + { + "key": "scopeTypes", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_role:ListRoleTemplatesRequestScopeTypesItem" + } + }, + "description": "Filter role templates based on the scope of permissions they include." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RoleTemplate" + } + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/role-templates", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "name": "Deployment_Viewer", + "permissions": [ + "permissions" + ], + "scopeType": "DEPLOYMENT", + "description": "Subject can only view deployments." + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/role-templates \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/role-templates", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/role-templates \\\n -H \"Authorization: Bearer \" \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/role-templates", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/role-templates \\\n -H \"Authorization: Bearer \" \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/role-templates", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/role-templates \\\n -H \"Authorization: Bearer \" \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/role-templates", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/role-templates \\\n -H \"Authorization: Bearer \" \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/role-templates", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/role-templates \\\n -H \"Authorization: Bearer \" \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + } + ] + }, + "subpackage_role.ListRoles": { + "id": "subpackage_role.ListRoles", + "namespace": [ + "subpackage_role" + ], + "description": "List available user roles in an Organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Organization's ID." + } + ], + "queryParameters": [ + { + "key": "includeDefaultRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to include default Astro roles in the returned list." + }, + { + "key": "scopeTypes", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_role:ListRolesRequestScopeTypesItem" + } + }, + "description": "Filter the list of roles based on the scope of each role." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Offset for pagination." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Limit for pagination." + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_role:ListRolesRequestSortsItem" + } + }, + "description": "Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RolesPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/roles", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "limit": 1, + "offset": 1, + "roles": [ + { + "createdAt": "createdAt", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "id": "cluc9tapx000901qn2xrgqdmn", + "name": "Deployment_Viewer", + "restrictedWorkspaceIds": [ + "restrictedWorkspaceIds" + ], + "scopeType": "DEPLOYMENT", + "updatedAt": "updatedAt", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "description": "Subject can only view deployments." + } + ], + "totalCount": 1, + "defaultRoles": [ + { + "name": "Deployment_Viewer", + "permissions": [ + "permissions" + ], + "scopeType": "DEPLOYMENT", + "description": "Subject can only view deployments." + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "includeDefaultRoles": true, + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -d includeDefaultRoles=true \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "includeDefaultRoles": true, + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -d includeDefaultRoles=true \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "includeDefaultRoles": true, + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -d includeDefaultRoles=true \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "includeDefaultRoles": true, + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -d includeDefaultRoles=true \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "includeDefaultRoles": true, + "scopeTypes": "DEPLOYMENT" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -d includeDefaultRoles=true \\\n -d scopeTypes=DEPLOYMENT", + "generated": true + } + ] + } + } + ] + }, + "subpackage_role.CreateCustomRole": { + "id": "subpackage_role.CreateCustomRole", + "namespace": [ + "subpackage_role" + ], + "description": "Create a custom role that you can assign to users, Teams, and API tokens.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where you want to create the custom role." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's name." + }, + { + "key": "permissions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The permissions included in the role." + }, + { + "key": "restrictedWorkspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The IDs of the Workspaces that the role is restricted to." + }, + { + "key": "scopeType", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "DEPLOYMENT" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleWithPermission" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/roles", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Deployment_Viewer", + "permissions": [ + "permissions" + ], + "scopeType": "DEPLOYMENT", + "description": "Subject can only view deployments." + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "createdAt", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "cluc9tapx000901qn2xrgqdmn", + "name": "Deployment_Viewer", + "permissions": [ + "permissions" + ], + "restrictedWorkspaceIds": [ + "restrictedWorkspaceIds" + ], + "scopeType": "DEPLOYMENT", + "updatedAt": "updatedAt", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "description": "Subject can only view deployments." + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Deployment_Viewer\",\n \"permissions\": [\n \"permissions\"\n ],\n \"scopeType\": \"DEPLOYMENT\",\n \"description\": \"Subject can only view deployments.\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ], + "scopeType": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ],\n \"scopeType\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ], + "scopeType": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ],\n \"scopeType\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ], + "scopeType": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ],\n \"scopeType\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ], + "scopeType": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ],\n \"scopeType\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ], + "scopeType": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ],\n \"scopeType\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_role.UpdateCustomRole": { + "id": "subpackage_role.UpdateCustomRole", + "namespace": [ + "subpackage_role" + ], + "description": "Update the metadata or included permissions for a custom role.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/roles/" + }, + { + "type": "pathParameter", + "value": "customRoleId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the role belongs." + }, + { + "key": "customRoleId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The custom role's ID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's name." + }, + { + "key": "permissions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The permissions included in the role." + }, + { + "key": "restrictedWorkspaceIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The IDs of the Workspaces that the role is restricted to." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleWithPermission" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/roles/customRoleId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "customRoleId": "customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Deployment_Viewer", + "permissions": [ + "permissions" + ], + "description": "Subject can only view deployments." + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "createdAt", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "cluc9tapx000901qn2xrgqdmn", + "name": "Deployment_Viewer", + "permissions": [ + "permissions" + ], + "restrictedWorkspaceIds": [ + "restrictedWorkspaceIds" + ], + "scopeType": "DEPLOYMENT", + "updatedAt": "updatedAt", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "description": "Subject can only view deployments." + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles/customRoleId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Deployment_Viewer\",\n \"permissions\": [\n \"permissions\"\n ],\n \"description\": \"Subject can only view deployments.\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "permissions": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"permissions\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_role.DeleteCustomRole": { + "id": "subpackage_role.DeleteCustomRole", + "namespace": [ + "subpackage_role" + ], + "description": "Delete a custom role.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/roles/" + }, + { + "type": "pathParameter", + "value": "customRoleId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the role belongs." + }, + { + "key": "customRoleId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the role to delete." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/roles/customRoleId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "customRoleId": "customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles/customRoleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:customRoleId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "customRoleId": ":customRoleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:customRoleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_role.GetCustomRole": { + "id": "subpackage_role.GetCustomRole", + "namespace": [ + "subpackage_role" + ], + "description": "Get details about a custom role.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/roles/" + }, + { + "type": "pathParameter", + "value": "roleId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the role belongs." + }, + { + "key": "roleId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleWithPermission" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/roles/roleId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "roleId": "roleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "createdAt": "createdAt", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "id": "cluc9tapx000901qn2xrgqdmn", + "name": "Deployment_Viewer", + "permissions": [ + "permissions" + ], + "restrictedWorkspaceIds": [ + "restrictedWorkspaceIds" + ], + "scopeType": "DEPLOYMENT", + "updatedAt": "updatedAt", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "description": "Subject can only view deployments." + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles/roleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:roleId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "roleId": ":roleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:roleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:roleId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "roleId": ":roleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:roleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:roleId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "roleId": ":roleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:roleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:roleId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "roleId": ":roleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:roleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/roles/:roleId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "roleId": ":roleId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles/:roleId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.ListTeams": { + "id": "subpackage_team.ListTeams", + "namespace": [ + "subpackage_team" + ], + "description": "List all Teams in an Organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Organization to list Teams for." + } + ], + "queryParameters": [ + { + "key": "names", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of names for Teams to filter by. The API returns details only for the specified Teams." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Offset for pagination" + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Limit for pagination" + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_team:ListTeamsRequestSortsItem" + } + }, + "description": "Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:TeamsPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "limit": 10, + "offset": 0, + "teams": [ + { + "createdAt": "2022-11-22T04:37:12Z", + "id": "clma5ftgk000008mhgev00k7d", + "isIdpManaged": false, + "name": "My Team", + "organizationId": "clma5g8q6000108mh88g27k1y", + "organizationRole": "ORGANIZATION_OWNER", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "description": "My Team description", + "rolesCount": 1, + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + ], + "totalCount": 100 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "offset": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d offset=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "offset": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d offset=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "offset": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d offset=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "offset": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d offset=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "names": "string", + "offset": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -d names=string \\\n -d offset=0", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.CreateTeam": { + "id": "subpackage_team.CreateTeam", + "namespace": [ + "subpackage_team" + ], + "description": "Create a Team in an Organization. A Team is a group of users that have the same set of permissions in an Organization or Workspace.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where the Team is created." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Team's description." + }, + { + "key": "memberIds", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The list of IDs for users to add to the Team." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Team's name." + }, + { + "key": "organizationRole", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_team:CreateTeamRequestOrganizationRole" + } + }, + "description": "The Team's Organization role." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Team" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Team", + "description": "My Team description" + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "id": "clma5ftgk000008mhgev00k7d", + "isIdpManaged": false, + "name": "My Team", + "organizationId": "clma5g8q6000108mh88g27k1y", + "organizationRole": "ORGANIZATION_OWNER", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "description": "My Team description", + "rolesCount": 1, + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Team\",\n \"description\": \"My Team description\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.GetTeam": { + "id": "subpackage_team.GetTeam", + "namespace": [ + "subpackage_team" + ], + "description": "Retrieve details about a specific Team.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams/" + }, + { + "type": "pathParameter", + "value": "teamId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Team belongs." + }, + { + "key": "teamId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Team to retrieve data for." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Team" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams/teamId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "teamId": "teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "id": "clma5ftgk000008mhgev00k7d", + "isIdpManaged": false, + "name": "My Team", + "organizationId": "clma5g8q6000108mh88g27k1y", + "organizationRole": "ORGANIZATION_OWNER", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "description": "My Team description", + "rolesCount": 1, + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.UpdateTeam": { + "id": "subpackage_team.UpdateTeam", + "namespace": [ + "subpackage_team" + ], + "description": "Update a Team's details.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams/" + }, + { + "type": "pathParameter", + "value": "teamId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Team belongs." + }, + { + "key": "teamId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Team to update." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Team's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Team's name." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Team" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams/teamId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "teamId": "teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Team", + "description": "My Team Description" + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "id": "clma5ftgk000008mhgev00k7d", + "isIdpManaged": false, + "name": "My Team", + "organizationId": "clma5g8q6000108mh88g27k1y", + "organizationRole": "ORGANIZATION_OWNER", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "description": "My Team description", + "rolesCount": 1, + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Team\",\n \"description\": \"My Team Description\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.DeleteTeam": { + "id": "subpackage_team.DeleteTeam", + "namespace": [ + "subpackage_team" + ], + "description": "Delete a Team. Deleting a Team will remove all permissions associated with the Team. Users that previously belonged to the Team will no longer have these permissions.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams/" + }, + { + "type": "pathParameter", + "value": "teamId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to delete the Team from." + }, + { + "key": "teamId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Team to delete." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams/teamId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "teamId": "teamId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.ListTeamMembers": { + "id": "subpackage_team.ListTeamMembers", + "namespace": [ + "subpackage_team" + ], + "description": "List the details about all users that belong to a specific Team.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams/" + }, + { + "type": "pathParameter", + "value": "teamId" + }, + { + "type": "literal", + "value": "/members" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Team belongs." + }, + { + "key": "teamId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Team to retrieve member information for." + } + ], + "queryParameters": [ + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Offset for pagination" + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Limit for pagination" + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_team:ListTeamMembersRequestSortsItem" + } + }, + "description": "Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:TeamMembersPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams/teamId/members", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "teamId": "teamId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "limit": 10, + "offset": 0, + "teamMembers": [ + { + "userId": "clma5vzk2000108k20jhq3f7n", + "username": "user1@company.com", + "avatarUrl": "https://avatar.url", + "createdAt": "2022-11-22T04:37:12Z", + "fullName": "Jane Doe" + } + ], + "totalCount": 100 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId/members \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.AddTeamMembers": { + "id": "subpackage_team.AddTeamMembers", + "namespace": [ + "subpackage_team" + ], + "description": "Add members to a team", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams/" + }, + { + "type": "pathParameter", + "value": "teamId" + }, + { + "type": "literal", + "value": "/members" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "organization ID" + }, + { + "key": "teamId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "team ID" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "memberIds", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The list of IDs for users to add to the Team." + } + ] + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams/teamId/members", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "teamId": "teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "memberIds": [ + "memberIds" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId/members \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"memberIds\": [\n \"memberIds\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "memberIds": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"memberIds\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "memberIds": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"memberIds\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "memberIds": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"memberIds\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "memberIds": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"memberIds\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "memberIds": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"memberIds\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.RemoveTeamMember": { + "id": "subpackage_team.RemoveTeamMember", + "namespace": [ + "subpackage_team" + ], + "description": "Remove a user from a Team. The user loses all permissions associated with the Team.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams/" + }, + { + "type": "pathParameter", + "value": "teamId" + }, + { + "type": "literal", + "value": "/members/" + }, + { + "type": "pathParameter", + "value": "memberId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the user belongs." + }, + { + "key": "teamId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Team to remove the user from." + }, + { + "key": "memberId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the user to remove." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams/teamId/members/memberId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "teamId": "teamId", + "memberId": "memberId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId/members/memberId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members/:memberId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId", + "memberId": ":memberId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members/:memberId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members/:memberId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId", + "memberId": ":memberId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members/:memberId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members/:memberId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId", + "memberId": ":memberId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members/:memberId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members/:memberId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId", + "memberId": ":memberId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members/:memberId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/members/:memberId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId", + "memberId": ":memberId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/members/:memberId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_team.UpdateTeamRoles": { + "id": "subpackage_team.UpdateTeamRoles", + "namespace": [ + "subpackage_team" + ], + "description": "Update Organization and Workspace roles for a Team.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/teams/" + }, + { + "type": "pathParameter", + "value": "teamId" + }, + { + "type": "literal", + "value": "/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Team belongs." + }, + { + "key": "teamId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Team to update roles for." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deploymentRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentRole" + } + } + }, + "description": "The user's updated Deployment roles. The Deployments you specify must belong to the Team's Organization." + }, + { + "key": "organizationRole", + "valueShape": { + "type": "id", + "id": "type_team:UpdateTeamRolesRequestOrganizationRole" + }, + "description": "The Team's Organization roles." + }, + { + "key": "workspaceRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkspaceRole" + } + } + }, + "description": "The Team's updated Workspace roles. The Workspaces you specify must belong to the Team's Organization." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SubjectRoles" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/teams/teamId/roles", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "teamId": "teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "organizationRole": "ORGANIZATION_OWNER", + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "organizationRole": "ORGANIZATION_OWNER", + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"organizationRole\": \"ORGANIZATION_OWNER\",\n \"deploymentRoles\": [\n {\n \"deploymentId\": \"clm8t5u4q000008jq4qoc3031\",\n \"role\": \"DEPLOYMENT_ADMIN\"\n }\n ],\n \"workspaceRoles\": [\n {\n \"role\": \"WORKSPACE_OWNER\",\n \"workspaceId\": \"clm8t5u4q000008jq4qoc3036\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/roles", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "organizationRole": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"organizationRole\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/roles", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "organizationRole": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"organizationRole\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/roles", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "organizationRole": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"organizationRole\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/roles", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "organizationRole": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"organizationRole\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/teams/:teamId/roles", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "teamId": ":teamId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "organizationRole": "ORGANIZATION_OWNER" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/teams/:teamId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"organizationRole\": \"ORGANIZATION_OWNER\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_apiToken.ListApiTokens": { + "id": "subpackage_apiToken.ListApiTokens", + "namespace": [ + "subpackage_apiToken" + ], + "description": "List information about all API tokens from an Organization. Filters on Workspace when Workspace ID is provided. When `includeOnlyOrganizationTokens` is `true`, only Organization API tokens are returned.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/tokens" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to list tokens for." + } + ], + "queryParameters": [ + { + "key": "workspaceId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the Workspace to list API tokens for." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the Deployment to list API tokens for." + }, + { + "key": "includeOnlyOrganizationTokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to show only Organization API tokens." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Offset for pagination" + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Limit for pagination" + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_apiToken:ListApiTokensRequestSortsItem" + } + }, + "description": "Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiTokensPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/tokens", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "limit": 10, + "offset": 0, + "tokens": [ + { + "createdAt": "2022-11-22T04:37:12Z", + "description": "my token description", + "id": "clm8q7f6q000008lcgyougpsk", + "name": "My token", + "shortToken": "short-token", + "startAt": "2022-11-22T04:37:12Z", + "type": "DEPLOYMENT", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + }, + "endAt": "2022-11-22T04:37:12Z", + "expiryPeriodInDays": 30, + "lastUsedAt": "2022-11-22T04:37:12Z", + "roles": [ + { + "entityId": "clm8sgvai000008l794psbkdv", + "entityType": "DEPLOYMENT", + "role": "WORKSPACE_MEMBER" + } + ], + "token": "token", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "username": "user1@company.com" + } + } + ], + "totalCount": 100 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_apiToken.CreateApiToken": { + "id": "subpackage_apiToken.CreateApiToken", + "namespace": [ + "subpackage_apiToken" + ], + "description": "Create an API token. An API token is an alphanumeric token that grants programmatic access to Astro for automated workflows. An API token can be scoped to an Organization or a Workspace.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/tokens" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where you want to create the token." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description for the API token." + }, + { + "key": "entityId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the Workspace or Deployment to which the API token is scoped. It is required if `Type` is `WORKSPACE` or `DEPLOYMENT`." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the API token." + }, + { + "key": "role", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role of the API token." + }, + { + "key": "tokenExpiryPeriodInDays", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The expiry period of the API token in days. If not specified, the token will never expire." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_apiToken:CreateApiTokenRequestType" + }, + "description": "The scope of the API token." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiToken" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/tokens", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My token", + "role": "WORKSPACE_OWNER", + "type": "DEPLOYMENT", + "description": "This is my API token", + "entityId": "clm8pxjjw000008l23jm08hyu", + "tokenExpiryPeriodInDays": 30 + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "description": "my token description", + "id": "clm8q7f6q000008lcgyougpsk", + "name": "My token", + "shortToken": "short-token", + "startAt": "2022-11-22T04:37:12Z", + "type": "DEPLOYMENT", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "endAt": "2022-11-22T04:37:12Z", + "expiryPeriodInDays": 30, + "lastUsedAt": "2022-11-22T04:37:12Z", + "roles": [ + { + "entityId": "clm8sgvai000008l794psbkdv", + "entityType": "DEPLOYMENT", + "role": "WORKSPACE_MEMBER" + } + ], + "token": "token", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My token\",\n \"role\": \"WORKSPACE_OWNER\",\n \"type\": \"DEPLOYMENT\",\n \"description\": \"This is my API token\",\n \"entityId\": \"clm8pxjjw000008l23jm08hyu\",\n \"tokenExpiryPeriodInDays\": 30\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "role": "string", + "type": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"role\": \"string\",\n \"type\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "role": "string", + "type": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"role\": \"string\",\n \"type\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "role": "string", + "type": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"role\": \"string\",\n \"type\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "role": "string", + "type": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"role\": \"string\",\n \"type\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "role": "string", + "type": "DEPLOYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"role\": \"string\",\n \"type\": \"DEPLOYMENT\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_apiToken.GetApiToken": { + "id": "subpackage_apiToken.GetApiToken", + "namespace": [ + "subpackage_apiToken" + ], + "description": "Retrieve information about a specific API token.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/tokens/" + }, + { + "type": "pathParameter", + "value": "tokenId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where you want to retrieve token information." + }, + { + "key": "tokenId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the token that you want to retrieve data for." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiToken" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/tokens/tokenId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "tokenId": "tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "description": "my token description", + "id": "clm8q7f6q000008lcgyougpsk", + "name": "My token", + "shortToken": "short-token", + "startAt": "2022-11-22T04:37:12Z", + "type": "DEPLOYMENT", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "endAt": "2022-11-22T04:37:12Z", + "expiryPeriodInDays": 30, + "lastUsedAt": "2022-11-22T04:37:12Z", + "roles": [ + { + "entityId": "clm8sgvai000008l794psbkdv", + "entityType": "DEPLOYMENT", + "role": "WORKSPACE_MEMBER" + } + ], + "token": "token", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens/tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_apiToken.UpdateApiToken": { + "id": "subpackage_apiToken.UpdateApiToken", + "namespace": [ + "subpackage_apiToken" + ], + "description": "Update the name and description of an API token.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/tokens/" + }, + { + "type": "pathParameter", + "value": "tokenId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where you want to update an API token." + }, + { + "key": "tokenId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The API token you want to update." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the API token." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the API token." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiToken" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/tokens/tokenId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "tokenId": "tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My token", + "description": "This is my API token" + } + }, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "description": "my token description", + "id": "clm8q7f6q000008lcgyougpsk", + "name": "My token", + "shortToken": "short-token", + "startAt": "2022-11-22T04:37:12Z", + "type": "DEPLOYMENT", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "endAt": "2022-11-22T04:37:12Z", + "expiryPeriodInDays": 30, + "lastUsedAt": "2022-11-22T04:37:12Z", + "roles": [ + { + "entityId": "clm8sgvai000008l794psbkdv", + "entityType": "DEPLOYMENT", + "role": "WORKSPACE_MEMBER" + } + ], + "token": "token", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens/tokenId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My token\",\n \"description\": \"This is my API token\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_apiToken.DeleteApiToken": { + "id": "subpackage_apiToken.DeleteApiToken", + "namespace": [ + "subpackage_apiToken" + ], + "description": "Delete an API token. When you delete an API token, make sure that no existing automation workflows are using it. After it's deleted, an API token cannot be recovered.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/tokens/" + }, + { + "type": "pathParameter", + "value": "tokenId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where you want to delete the token." + }, + { + "key": "tokenId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The API token ID" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/tokens/tokenId", + "responseStatusCode": 204, + "pathParameters": { + "organizationId": "organizationId", + "tokenId": "tokenId" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens/tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_apiToken.UpdateApiTokenRoles": { + "id": "subpackage_apiToken.UpdateApiTokenRoles", + "namespace": [ + "subpackage_apiToken" + ], + "description": "Update Workspace and Organization roles for an API token.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/tokens/" + }, + { + "type": "pathParameter", + "value": "tokenId" + }, + { + "type": "literal", + "value": "/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where you want to update an API token." + }, + { + "key": "tokenId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The API token you want to update." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "roles", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ApiTokenRole" + } + }, + "description": "The roles of the API token." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SubjectRoles" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/tokens/tokenId/roles", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "tokenId": "tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "roles": [ + { + "entityId": "clm8sgvai000008l794psbkdv", + "entityType": "DEPLOYMENT", + "role": "WORKSPACE_MEMBER" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "organizationRole": "ORGANIZATION_OWNER", + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens/tokenId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roles\": [\n {\n \"entityId\": \"clm8sgvai000008l794psbkdv\",\n \"entityType\": \"DEPLOYMENT\",\n \"role\": \"WORKSPACE_MEMBER\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/roles", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "roles": [ + { + "entityId": "string", + "entityType": "DEPLOYMENT", + "role": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roles\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"DEPLOYMENT\",\n \"role\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/roles", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "roles": [ + { + "entityId": "string", + "entityType": "DEPLOYMENT", + "role": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roles\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"DEPLOYMENT\",\n \"role\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/roles", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "roles": [ + { + "entityId": "string", + "entityType": "DEPLOYMENT", + "role": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roles\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"DEPLOYMENT\",\n \"role\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/roles", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "roles": [ + { + "entityId": "string", + "entityType": "DEPLOYMENT", + "role": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roles\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"DEPLOYMENT\",\n \"role\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/roles", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "roles": [ + { + "entityId": "string", + "entityType": "DEPLOYMENT", + "role": "string" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roles\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"DEPLOYMENT\",\n \"role\": \"string\"\n }\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_apiToken.RotateApiToken": { + "id": "subpackage_apiToken.RotateApiToken", + "namespace": [ + "subpackage_apiToken" + ], + "description": "Rotate an API token. Creates a new API token and invalidates the one you specify. Any workflows using the previous value stop working.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/tokens/" + }, + { + "type": "pathParameter", + "value": "tokenId" + }, + { + "type": "literal", + "value": "/rotate" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where you want to rotate an API token." + }, + { + "key": "tokenId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The token to rotate" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiToken" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/tokens/tokenId/rotate", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "tokenId": "tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "createdAt": "2022-11-22T04:37:12Z", + "description": "my token description", + "id": "clm8q7f6q000008lcgyougpsk", + "name": "My token", + "shortToken": "short-token", + "startAt": "2022-11-22T04:37:12Z", + "type": "DEPLOYMENT", + "updatedAt": "2022-11-22T04:37:12Z", + "createdBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + }, + "endAt": "2022-11-22T04:37:12Z", + "expiryPeriodInDays": 30, + "lastUsedAt": "2022-11-22T04:37:12Z", + "roles": [ + { + "entityId": "clm8sgvai000008l794psbkdv", + "entityType": "DEPLOYMENT", + "role": "WORKSPACE_MEMBER" + } + ], + "token": "token", + "updatedBy": { + "id": "clm8qv74h000008mlf08scq7k", + "apiTokenName": "my-token", + "avatarUrl": "https://avatar.url", + "fullName": "Jane Doe", + "subjectType": "USER", + "username": "user1@company.com" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/tokens/tokenId/rotate \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/rotate", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/rotate \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/rotate", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/rotate \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/rotate", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/rotate \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/rotate", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/rotate \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/tokens/:tokenId/rotate", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "tokenId": ":tokenId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/tokens/:tokenId/rotate \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_user.ListUsers": { + "id": "subpackage_user.ListUsers", + "namespace": [ + "subpackage_user" + ], + "description": "List users in an Organization or a specific Workspace within an Organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to list users for." + } + ], + "queryParameters": [ + { + "key": "workspaceId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the Workspace to filter the list of users for. When specified, the API returns only users belonging to the specified Workspace." + }, + { + "key": "deploymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the Deployment to filter the list of users for. When specified, the API returns only users belonging to the specified Deployment." + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Offset for pagination" + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Limit for pagination" + }, + { + "key": "sorts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_user:ListUsersRequestSortsItem" + } + }, + "description": "Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UsersPaginated" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/users", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "limit": 10, + "offset": 0, + "totalCount": 100, + "users": [ + { + "avatarUrl": "https://avatar.url", + "createdAt": "2022-11-22T04:37:12Z", + "fullName": "Jane Doe", + "id": "clm9sq6s0000008kz7uvl7yz7", + "status": "ACTIVE", + "updatedAt": "2022-11-22T04:37:12Z", + "username": "user1@company.com", + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "organizationRole": "ORGANIZATION_OWNER", + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/users \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId" + }, + "queryParameters": { + "workspaceId": "string", + "deploymentId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users \\\n -H \"Authorization: Bearer \" \\\n -d workspaceId=string \\\n -d deploymentId=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_user.GetUser": { + "id": "subpackage_user.GetUser", + "namespace": [ + "subpackage_user" + ], + "description": "Retrieve user information about a specific user account.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "userId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the user belongs." + }, + { + "key": "userId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The user's ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:User" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/users/userId", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "userId": "userId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "avatarUrl": "https://avatar.url", + "createdAt": "2022-11-22T04:37:12Z", + "fullName": "Jane Doe", + "id": "clm9sq6s0000008kz7uvl7yz7", + "status": "ACTIVE", + "updatedAt": "2022-11-22T04:37:12Z", + "username": "user1@company.com", + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "organizationRole": "ORGANIZATION_OWNER", + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/users/userId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_user.UpdateUserRoles": { + "id": "subpackage_user.UpdateUserRoles", + "namespace": [ + "subpackage_user" + ], + "description": "Update Organization and Workspace roles for a user.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/organizations/" + }, + { + "type": "pathParameter", + "value": "organizationId" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "userId" + }, + { + "type": "literal", + "value": "/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.astronomer.io/iam/v1beta1" + } + ], + "pathParameters": [ + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the user belongs." + }, + { + "key": "userId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The user's ID" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deploymentRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentRole" + } + } + }, + "description": "The user's updated Deployment roles. Requires also specifying an `OrganizationRole`." + }, + { + "key": "organizationRole", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_user:UpdateUserRolesRequestOrganizationRole" + } + }, + "description": "The user's updated Organization role." + }, + { + "key": "workspaceRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkspaceRole" + } + } + }, + "description": "The user's updated Workspace roles. Requires also specifying an `OrganizationRole`." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SubjectRoles" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + }, + { + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Error" + } + } + } + ], + "examples": [ + { + "path": "/organizations/organizationId/users/userId/roles", + "responseStatusCode": 200, + "pathParameters": { + "organizationId": "organizationId", + "userId": "userId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "deploymentRoles": [ + { + "deploymentId": "clm8t5u4q000008jq4qoc3031", + "role": "DEPLOYMENT_ADMIN" + } + ], + "organizationRole": "ORGANIZATION_OWNER", + "workspaceRoles": [ + { + "role": "WORKSPACE_OWNER", + "workspaceId": "clm8t5u4q000008jq4qoc3036" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/users/userId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deploymentRoles\": [\n {\n \"deploymentId\": \"clm8t5u4q000008jq4qoc3031\",\n \"role\": \"DEPLOYMENT_ADMIN\"\n }\n ],\n \"workspaceRoles\": [\n {\n \"role\": \"WORKSPACE_OWNER\",\n \"workspaceId\": \"clm8t5u4q000008jq4qoc3036\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId/roles", + "responseStatusCode": 400, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId/roles", + "responseStatusCode": 401, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId/roles", + "responseStatusCode": 403, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId/roles", + "responseStatusCode": 404, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/organizations/:organizationId/users/:userId/roles", + "responseStatusCode": 500, + "pathParameters": { + "organizationId": ":organizationId", + "userId": ":userId" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "requestId": "string", + "statusCode": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/users/:userId/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_authorization:ListPermissionGroupsRequestScopeType": { + "name": "ListPermissionGroupsRequestScopeType", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_invite:CreateUserInviteRequestRole": { + "name": "CreateUserInviteRequestRole", + "description": "The user's Organization role.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ORGANIZATION_OWNER" + }, + { + "value": "ORGANIZATION_BILLING_ADMIN" + }, + { + "value": "ORGANIZATION_MEMBER" + } + ] + } + }, + "type_role:ListRoleTemplatesRequestScopeTypesItem": { + "name": "ListRoleTemplatesRequestScopeTypesItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_role:ListRolesRequestScopeTypesItem": { + "name": "ListRolesRequestScopeTypesItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_role:ListRolesRequestSortsItem": { + "name": "ListRolesRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "name:asc" + }, + { + "value": "name:desc" + }, + { + "value": "scopeType:asc" + }, + { + "value": "scopeType:desc" + }, + { + "value": "description:asc" + }, + { + "value": "description:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + } + ] + } + }, + "type_team:ListTeamsRequestSortsItem": { + "name": "ListTeamsRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "name:asc" + }, + { + "value": "name:desc" + }, + { + "value": "description:asc" + }, + { + "value": "description:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + } + ] + } + }, + "type_team:CreateTeamRequestOrganizationRole": { + "name": "CreateTeamRequestOrganizationRole", + "description": "The Team's Organization role.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ORGANIZATION_OWNER" + }, + { + "value": "ORGANIZATION_BILLING_ADMIN" + }, + { + "value": "ORGANIZATION_MEMBER" + } + ] + } + }, + "type_team:ListTeamMembersRequestSortsItem": { + "name": "ListTeamMembersRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "userId:asc" + }, + { + "value": "userId:desc" + }, + { + "value": "fullName:asc" + }, + { + "value": "fullName:desc" + }, + { + "value": "username:asc" + }, + { + "value": "username:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + } + ] + } + }, + "type_team:UpdateTeamRolesRequestOrganizationRole": { + "name": "UpdateTeamRolesRequestOrganizationRole", + "description": "The Team's Organization roles.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ORGANIZATION_OWNER" + }, + { + "value": "ORGANIZATION_BILLING_ADMIN" + }, + { + "value": "ORGANIZATION_MEMBER" + } + ] + } + }, + "type_apiToken:ListApiTokensRequestSortsItem": { + "name": "ListApiTokensRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "name:asc" + }, + { + "value": "name:desc" + }, + { + "value": "description:asc" + }, + { + "value": "description:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + }, + { + "value": "tokenStartAt:asc" + }, + { + "value": "tokenStartAt:desc" + } + ] + } + }, + "type_apiToken:CreateApiTokenRequestType": { + "name": "CreateApiTokenRequestType", + "description": "The scope of the API token.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_user:ListUsersRequestSortsItem": { + "name": "ListUsersRequestSortsItem", + "shape": { + "type": "enum", + "values": [ + { + "value": "id:asc" + }, + { + "value": "id:desc" + }, + { + "value": "username:asc" + }, + { + "value": "username:desc" + }, + { + "value": "fullName:asc" + }, + { + "value": "fullName:desc" + }, + { + "value": "createdAt:asc" + }, + { + "value": "createdAt:desc" + }, + { + "value": "updatedAt:asc" + }, + { + "value": "updatedAt:desc" + } + ] + } + }, + "type_user:UpdateUserRolesRequestOrganizationRole": { + "name": "UpdateUserRolesRequestOrganizationRole", + "description": "The user's updated Organization role.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ORGANIZATION_OWNER" + }, + { + "value": "ORGANIZATION_BILLING_ADMIN" + }, + { + "value": "ORGANIZATION_MEMBER" + } + ] + } + }, + "type_:ApiTokenType": { + "name": "ApiTokenType", + "description": "The type of the API token.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_:ApiToken": { + "name": "ApiToken", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the API token was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "createdBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The description of the API token." + }, + { + "key": "endAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The time when the API token expires in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "expiryPeriodInDays", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The expiry period of the API token in days." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The API token's ID." + }, + { + "key": "lastUsedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The time when the API token was last used in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the API token." + }, + { + "key": "roles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ApiTokenRole" + } + } + }, + "description": "The roles of the API token." + }, + { + "key": "shortToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The short value of the API token." + }, + { + "key": "startAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the API token will become valid in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The value of the API token." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ApiTokenType" + }, + "description": "The type of the API token." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the API token was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "updatedBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + } + ] + } + }, + "type_:ApiTokenRoleEntityType": { + "name": "ApiTokenRoleEntityType", + "description": "The type of the entity to which the API token is scoped for.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_:ApiTokenRole": { + "name": "ApiTokenRole", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "entityId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the entity to which the API token is scoped for. For example, for Workspace API tokens, this is the Workspace ID." + }, + { + "key": "entityType", + "valueShape": { + "type": "id", + "id": "type_:ApiTokenRoleEntityType" + }, + "description": "The type of the entity to which the API token is scoped for." + }, + { + "key": "role", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role of the API token." + } + ] + } + }, + "type_:ApiTokensPaginated": { + "name": "ApiTokensPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The limit of values in this page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of values in this page." + }, + { + "key": "tokens", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ApiToken" + } + }, + "description": "The list of API tokens in this page." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of API tokens." + } + ] + } + }, + "type_:BasicSubjectProfileSubjectType": { + "name": "BasicSubjectProfileSubjectType", + "description": "The subject type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "USER" + }, + { + "value": "SERVICEKEY" + } + ] + } + }, + "type_:BasicSubjectProfile": { + "name": "BasicSubjectProfile", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "apiTokenName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The API token's name. Returned only when `SubjectType` is `SERVICEKEY`." + }, + { + "key": "avatarUrl", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL for the user's profile image. Returned only when `SubjectType` is `USER`." + }, + { + "key": "fullName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The subject's full name. Returned only when `SubjectType` is `USER`." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The subject's ID." + }, + { + "key": "subjectType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfileSubjectType" + } + }, + "description": "The subject type." + }, + { + "key": "username", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The subject's username. Returned only when `SubjectType` is `USER`." + } + ] + } + }, + "type_:DefaultRoleScopeType": { + "name": "DefaultRoleScopeType", + "description": "The role's scope.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + }, + { + "value": "SYSTEM" + } + ] + } + }, + "type_:DefaultRole": { + "name": "DefaultRole", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's name." + }, + { + "key": "permissions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's permissions." + }, + { + "key": "scopeType", + "valueShape": { + "type": "id", + "id": "type_:DefaultRoleScopeType" + }, + "description": "The role's scope." + } + ] + } + }, + "type_:DeploymentRole": { + "name": "DeploymentRole", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deploymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Deployment ID." + }, + { + "key": "role", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the role for the subject in the Deployment." + } + ] + } + }, + "type_:Error": { + "name": "Error", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "requestId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "statusCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:Invite": { + "name": "Invite", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "expiresAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The time when the invite is expired in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "inviteId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The invite ID." + }, + { + "key": "invitee", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + }, + { + "key": "inviter", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + }, + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization where the invite was sent." + }, + { + "key": "organizationName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Organization where the invite was sent." + }, + { + "key": "userId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID for the user who was invited." + } + ] + } + }, + "type_:PermissionEntry": { + "name": "PermissionEntry", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "action", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The permission's action." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The permission's description." + } + ] + } + }, + "type_:PermissionGroup": { + "name": "PermissionGroup", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The permission group's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The permission group's name." + }, + { + "key": "permissions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PermissionEntry" + } + }, + "description": "The permission group's permissions." + }, + { + "key": "scope", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The permission group's scope." + } + ] + } + }, + "type_:RoleScopeType": { + "name": "RoleScopeType", + "description": "The role's scope.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_:Role": { + "name": "Role", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The time the role was created." + }, + { + "key": "createdBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's description." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's ID." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's name." + }, + { + "key": "restrictedWorkspaceIds", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The IDs of Workspaces that the role is restricted to." + }, + { + "key": "scopeType", + "valueShape": { + "type": "id", + "id": "type_:RoleScopeType" + }, + "description": "The role's scope." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The time the role was last updated." + }, + { + "key": "updatedBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + ] + } + }, + "type_:RoleTemplateScopeType": { + "name": "RoleTemplateScopeType", + "description": "The role's scope.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + }, + { + "value": "SYSTEM" + } + ] + } + }, + "type_:RoleTemplate": { + "name": "RoleTemplate", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's description." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's name." + }, + { + "key": "permissions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's permissions." + }, + { + "key": "scopeType", + "valueShape": { + "type": "id", + "id": "type_:RoleTemplateScopeType" + }, + "description": "The role's scope." + } + ] + } + }, + "type_:RoleWithPermissionScopeType": { + "name": "RoleWithPermissionScopeType", + "description": "The role's scope.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DEPLOYMENT" + }, + { + "value": "WORKSPACE" + }, + { + "value": "ORGANIZATION" + } + ] + } + }, + "type_:RoleWithPermission": { + "name": "RoleWithPermission", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The time the role was created." + }, + { + "key": "createdBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's description." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's ID." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role's name." + }, + { + "key": "permissions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role's permissions." + }, + { + "key": "restrictedWorkspaceIds", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The IDs of Workspaces that the role is restricted to." + }, + { + "key": "scopeType", + "valueShape": { + "type": "id", + "id": "type_:RoleWithPermissionScopeType" + }, + "description": "The role's scope." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The time the role was last updated." + }, + { + "key": "updatedBy", + "valueShape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + ] + } + }, + "type_:RolesPaginated": { + "name": "RolesPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "defaultRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DefaultRole" + } + } + }, + "description": "The list of default roles." + }, + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of custom roles returned." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the custom roles." + }, + { + "key": "roles", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Role" + } + }, + "description": "The list of custom roles." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of custom roles." + } + ] + } + }, + "type_:SubjectRolesOrganizationRole": { + "name": "SubjectRolesOrganizationRole", + "description": "The subject's Organization role.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ORGANIZATION_OWNER" + }, + { + "value": "ORGANIZATION_BILLING_ADMIN" + }, + { + "value": "ORGANIZATION_MEMBER" + } + ] + } + }, + "type_:SubjectRoles": { + "name": "SubjectRoles", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deploymentRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentRole" + } + } + }, + "description": "A list of the subject's Deployment roles. Currently only for API tokens." + }, + { + "key": "organizationRole", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SubjectRolesOrganizationRole" + } + }, + "description": "The subject's Organization role." + }, + { + "key": "workspaceRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkspaceRole" + } + } + }, + "description": "A list of the subject's Workspace roles." + } + ] + } + }, + "type_:TeamOrganizationRole": { + "name": "TeamOrganizationRole", + "description": "The Team's Organization role.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ORGANIZATION_OWNER" + }, + { + "value": "ORGANIZATION_BILLING_ADMIN" + }, + { + "value": "ORGANIZATION_MEMBER" + } + ] + } + }, + "type_:Team": { + "name": "Team", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Team was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "createdBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + }, + { + "key": "deploymentRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentRole" + } + } + }, + "description": "The Team's role in each Deployment it belongs to." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Team's description." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Team's ID." + }, + { + "key": "isIdpManaged", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Team is managed by an identity provider (IdP)." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Team's name." + }, + { + "key": "organizationId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the Organization to which the Team belongs." + }, + { + "key": "organizationRole", + "valueShape": { + "type": "id", + "id": "type_:TeamOrganizationRole" + }, + "description": "The Team's Organization role." + }, + { + "key": "rolesCount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of roles the Team has." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the Team was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "updatedBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BasicSubjectProfile" + } + } + }, + { + "key": "workspaceRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkspaceRole" + } + } + }, + "description": "The Team's role in each Workspace it belongs to." + } + ] + } + }, + "type_:TeamMember": { + "name": "TeamMember", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "avatarUrl", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL for the Team member's profile image." + }, + { + "key": "createdAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The time when the Team member was added in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "fullName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Team member's full name." + }, + { + "key": "userId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Team member's ID." + }, + { + "key": "username", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Team member's username." + } + ] + } + }, + "type_:TeamMembersPaginated": { + "name": "TeamMembersPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of Team members in one page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the current page of Team members." + }, + { + "key": "teamMembers", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TeamMember" + } + }, + "description": "The list of Team members in the current page." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Team members." + } + ] + } + }, + "type_:TeamsPaginated": { + "name": "TeamsPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of Teams in one page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the current page of Teams." + }, + { + "key": "teams", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Team" + } + }, + "description": "The list of Teams in the current page." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Teams." + } + ] + } + }, + "type_:UserOrganizationRole": { + "name": "UserOrganizationRole", + "description": "The user's Organization role.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ORGANIZATION_OWNER" + }, + { + "value": "ORGANIZATION_BILLING_ADMIN" + }, + { + "value": "ORGANIZATION_MEMBER" + } + ] + } + }, + "type_:UserStatus": { + "name": "UserStatus", + "description": "The user's status.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ACTIVE" + }, + { + "value": "INACTIVE" + }, + { + "value": "PENDING" + }, + { + "value": "BANNED" + } + ] + } + }, + "type_:User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "avatarUrl", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL for the user's profile image." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the user was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "deploymentRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DeploymentRole" + } + } + }, + "description": "The user's Deployment roles." + }, + { + "key": "fullName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The user's full name." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The user's ID." + }, + { + "key": "organizationRole", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserOrganizationRole" + } + }, + "description": "The user's Organization role." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:UserStatus" + }, + "description": "The user's status." + }, + { + "key": "updatedAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time when the user was updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`." + }, + { + "key": "username", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The user's username." + }, + { + "key": "workspaceRoles", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WorkspaceRole" + } + } + }, + "description": "The user's Workspace roles." + } + ] + } + }, + "type_:UsersPaginated": { + "name": "UsersPaginated", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "limit", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The maximum number of users in one page." + }, + { + "key": "offset", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The offset of the current page of users." + }, + { + "key": "totalCount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of users." + }, + { + "key": "users", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:User" + } + }, + "description": "The list of users in the current page." + } + ] + } + }, + "type_:WorkspaceRoleRole": { + "name": "WorkspaceRoleRole", + "description": "The role of the subject in the Workspace.", + "shape": { + "type": "enum", + "values": [ + { + "value": "WORKSPACE_OWNER" + }, + { + "value": "WORKSPACE_OPERATOR" + }, + { + "value": "WORKSPACE_AUTHOR" + }, + { + "value": "WORKSPACE_MEMBER" + }, + { + "value": "WORKSPACE_ACCESSOR" + } + ] + } + }, + "type_:WorkspaceRole": { + "name": "WorkspaceRole", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "role", + "valueShape": { + "type": "id", + "id": "type_:WorkspaceRoleRole" + }, + "description": "The role of the subject in the Workspace." + }, + { + "key": "workspaceId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The Workspace ID." + } + ] + } + } + }, + "subpackages": { + "subpackage_authorization": { + "id": "subpackage_authorization", + "name": "authorization" + }, + "subpackage_invite": { + "id": "subpackage_invite", + "name": "Invite", + "displayName": "Invite" + }, + "subpackage_role": { + "id": "subpackage_role", + "name": "role" + }, + "subpackage_team": { + "id": "subpackage_team", + "name": "Team", + "displayName": "Team" + }, + "subpackage_apiToken": { + "id": "subpackage_apiToken", + "name": "ApiToken", + "displayName": "ApiToken" + }, + "subpackage_user": { + "id": "subpackage_user", + "name": "User", + "displayName": "User" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "token" + } + } + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/node.json b/packages/fdr-sdk/src/__test__/output/astronomer/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/node.json rename to packages/fdr-sdk/src/__test__/output/astronomer/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/astronomer/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/astronomer/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/astronomer/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/astronomer/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/pageIds.json b/packages/fdr-sdk/src/__test__/output/astronomer/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/pageIds.json rename to packages/fdr-sdk/src/__test__/output/astronomer/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/sitemap.json b/packages/fdr-sdk/src/__test__/output/astronomer/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/sitemap.json rename to packages/fdr-sdk/src/__test__/output/astronomer/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/astronomer/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/astronomer/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/astronomer/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/astronomer/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/slugs.json b/packages/fdr-sdk/src/__test__/output/astronomer/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/slugs.json rename to packages/fdr-sdk/src/__test__/output/astronomer/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/astronomer/versionNodes.json b/packages/fdr-sdk/src/__test__/output/astronomer/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/astronomer/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/astronomer/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-8099ff24-8ade-48d5-a54a-8d2d1831d806.json b/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-8099ff24-8ade-48d5-a54a-8d2d1831d806.json new file mode 100644 index 0000000000..e85e03e6a5 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-8099ff24-8ade-48d5-a54a-8d2d1831d806.json @@ -0,0 +1,2009 @@ +[ + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object/property/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object/property/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment_stream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/example/2/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object/property/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object/property/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/return_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment_stream/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.delete/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.delete/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/path/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/path/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/query/evaluatee_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/query/evaluator_aggregates", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/query/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/query/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/query/filter", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/query/user_filter", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/query/sort_by", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/query/order", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/request/object/property/directory_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/request/object/property/active_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/request/object/property/directory_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/query/evaluation_aggregates", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/request/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/request/object/property/class", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/request/object/property/values", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/query/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/query/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/path/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/request/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/request/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/path/dataset_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/query/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/query/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/path/dataset_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/query/evaluator_aggregates", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/query/evaluatee_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/query/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/query/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/query/evaluatee_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/path/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request/object/property/config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request/object/property/evaluator_ids", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request/object/property/dataset_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request/object/property/provider_api_keys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request/object/property/hl_generated", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/path/evaluation_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/query/evaluatee_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/request/object/property/datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/request/object/property/log", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/path/evaluation_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/query/evaluatee_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/request/object/property/log_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/request/object/property/evaluator_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/request/object/property/result", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/request/object/property/error", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/request/object/property/status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/request/object/property/evaluator_ids", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/request/object/property/evaluator_version_ids", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/query/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/query/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/query/start_date", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/query/end_date", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/query/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/query/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/query/evaluatee_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object/property/arguments_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object/property/return_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object/property/code", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request/object/property/arguments_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request/object/property/return_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request/object/property/code", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/search", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/metadata_search", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/version_status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/start_date", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/end_date", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/query/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete/query/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/query/reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/provider", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/max_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/temperature", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/top_p", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/stop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/presence_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/frequency_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/prompt_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/chat_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/endpoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object/property/tools", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/request/object/property/config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/query/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/query/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/query/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/query/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/query/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/path/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/path/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/request/object/property/config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/request/object/property/environments", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/path/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/path/environment_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/example/0/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/example/1/snippet/curl/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolCall/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolCall/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolCall/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolCall/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolCall/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolCall/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolCall/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolCall/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolCall/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolCall/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolCall/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolCall/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_datasets:Request/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_datasets:Request/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_datasets:Request/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_evaluations:CreateEvaluationResultLogRequestResult/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_evaluations:CreateEvaluationResultLogRequestResult/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_evaluations:CreateEvaluationResultLogRequestResult/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackRequest/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackRequest/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackResponse/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackResponse/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogRequest/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogRequest/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogResponse/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogResponse/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestStop/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestStop/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestToolsItem/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestToolsItem/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ModelConfigsSerializeRequest/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ModelConfigsSerializeRequest/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/created_by", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/agent_class", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/tools", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CategoricalFeedbackLabel/shape/object/property/value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CategoricalFeedbackLabel/shape/object/property/sentiment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/index", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/raw_output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/finish_reason", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/tool_results", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/tool_calls", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object/property/output_message", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Content/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Content/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape/object/property/content", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape/object/property/tool_call_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape/object/property/role", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape/object/property/tool_calls", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape/object/property/tool_call", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponseToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponseToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponseToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponseToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/data", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/usage", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/provider_responses", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/provider_request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatRole/shape/enum/value/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatRole/shape/enum/value/assistant", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatRole/shape/enum/value/system", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatRole/shape/enum/value/tool", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/num_samples", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/logprobs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/suffix", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/data", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/usage", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/provider_responses", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/provider_request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigType/shape/enum/value/generic", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigType/shape/enum/value/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigType/shape/enum/value/tool", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigType/shape/enum/value/agent", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigType/shape/enum/value/evaluator", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/4", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/5", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequest/shape/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequest/shape/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequest/shape/object/property/target", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointsByLogsRequest/shape/object/property/log_ids", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateLogResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateLogResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateLogResponse/shape/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateSessionResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DashboardConfiguration/shape/object/property/time_unit", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DashboardConfiguration/shape/object/property/time_range_days", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DashboardConfiguration/shape/object/property/model_config_ids", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/index", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/raw_output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/finish_reason", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object/property/tool_results", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/4", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/5", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse/shape/object/property/dataset_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse/shape/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse/shape/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse/shape/object/property/target", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object/property/datapoint_count", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object/property/project_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object/property/model_config_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object/property/environment_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object/property/environment_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object/property/environment_tag", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentRequest/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentRequest/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationDatapointSnapshotResponse/shape/object/property/datapoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationDatapointSnapshotResponse/shape/object/property/log", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationDatapointSnapshotResponse/shape/object/property/evaluation_results", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/evaluators", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/dataset", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/dataset_version_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/dataset_snapshot", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object/property/evaluator_aggregates", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Value/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Value/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Value/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Value/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/evaluator_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/evaluator_version_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/evaluation_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/log_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/log", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/version_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/version", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/error", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object/property/evaluator_log", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationStatus/shape/enum/value/pending", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationStatus/shape/enum/value/running", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationStatus/shape/enum/value/completed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationStatus/shape/enum/value/cancelled", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorArgumentsType/shape/enum/value/target_free", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorArgumentsType/shape/enum/value/target_required", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/created_by", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/evaluator_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/code", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/arguments_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object/property/return_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/arguments_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/return_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/code", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/model_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object/property/logging_project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/boolean", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/number", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/select", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/multi_select", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/text", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorType/shape/enum/value/python", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorType/shape/enum/value/llm", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorType/shape/enum/value/human", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorType/shape/enum/value/external", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackType/shape/enum/value/rating", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackType/shape/enum/value/action", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackType/shape/enum/value/issue", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackType/shape/enum/value/correction", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackType/shape/enum/value/comment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackValue/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackValue/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackValue/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackValue/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback/shape/object/property/value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback/shape/object/property/data_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback/shape/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackClass/shape/enum/value/select", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackClass/shape/enum/value/multi_select", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackClass/shape/enum/value/text", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackClass/shape/enum/value/number", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackLabelRequest/shape/object/property/value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackLabelRequest/shape/object/property/sentiment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestType/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestType/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestValue/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestValue/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestValue/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestValue/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape/object/property/value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape/object/property/data_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape/object/property/unset", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseType/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseType/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseValue/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseValue/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseValue/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseValue/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape/object/property/value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape/object/property/data_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModelType/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModelType/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModel/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModel/shape/object/property/values", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FileType/shape/enum/value/prompt", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FileType/shape/enum/value/tool", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FileType/shape/enum/value/dataset", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FileType/shape/enum/value/evaluator", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FileType/shape/enum/value/flow", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionTool/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionTool/shape/object/property/arguments", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionToolChoice/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape/object/property/created_by", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape/object/property/status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/project_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/last_used", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/num_datapoints", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/evaluation_aggregates", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object/property/environment_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:HTTPValidationError/shape/object/property/detail", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageChatContent/shape/object/property/image_url", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrlDetail/shape/enum/value/high", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrlDetail/shape/enum/value/low", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrlDetail/shape/enum/value/auto", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrl/shape/object/property/url", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrl/shape/object/property/detail", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LabelSentiment/shape/enum/value/positive", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LabelSentiment/shape/enum/value/negative", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LabelSentiment/shape/enum/value/neutral", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LabelSentiment/shape/enum/value/unset", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape/object/property/strict", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape/object/property/parameters", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Judgment/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Judgment/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Judgment/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Judgment/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequestFeedback/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequestFeedback/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/judgment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/feedback", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/error", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/stdout", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/duration", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/output_message", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/prompt_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/output_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/prompt_cost", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/output_cost", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/provider_request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object/property/provider_response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponseToolChoice/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponseToolChoice/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponseToolChoice/shape/undiscriminatedUnion/variant/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponseToolChoice/shape/undiscriminatedUnion/variant/3", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/project", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/session_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/session_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/parent_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/parent_reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/metadata", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/save", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/source_datapoint_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/messages", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/judgment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/environment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/feedback", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/error", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/stdout", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/duration", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/output_message", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/prompt_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/output_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/prompt_cost", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/output_cost", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/provider_request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/provider_response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/provider_latency", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/raw_output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/finish_reason", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/tools", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/tool_choice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/evaluation_results", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/observability_status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object/property/batch_ids", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestStop/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestStop/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestToolsItem/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestToolsItem/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/provider", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/max_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/temperature", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/top_p", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/stop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/presence_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/frequency_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/endpoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/chat_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object/property/tools", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequestStop/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequestStop/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/provider", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/max_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/temperature", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/top_p", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/stop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/presence_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/frequency_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/endpoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object/property/prompt_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigEvaluatorAggregateResponse/shape/object/property/model_config_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigEvaluatorAggregateResponse/shape/object/property/evaluator_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigEvaluatorAggregateResponse/shape/object/property/evaluator_version_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigEvaluatorAggregateResponse/shape/object/property/aggregate_value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestStop/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestStop/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestToolsItem/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestToolsItem/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/provider", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/max_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/temperature", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/top_p", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/stop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/presence_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/frequency_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/endpoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/prompt_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/chat_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object/property/tools", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponseStop/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponseStop/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/provider", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/max_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/temperature", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/top_p", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/stop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/presence_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/frequency_penalty", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/seed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/response_format", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/prompt_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/chat_template", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/tool_configs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/tools", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object/property/endpoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/strict", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/parameters", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/source_code", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object/property/preset_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelEndpoints/shape/enum/value/complete", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelEndpoints/shape/enum/value/chat", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelEndpoints/shape/enum/value/edit", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/openai", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/openai_azure", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/mock", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/anthropic", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/bedrock", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/cohere", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/replicate", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/google", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape/enum/value/groq", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ObservabilityStatus/shape/enum/value/pending", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ObservabilityStatus/shape/enum/value/running", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ObservabilityStatus/shape/enum/value/completed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ObservabilityStatus/shape/enum/value/failed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataDatapointResponse/shape/object/property/records", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataDatapointResponse/shape/object/property/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataDatapointResponse/shape/object/property/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataDatapointResponse/shape/object/property/total", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationDatapointSnapshotResponse/shape/object/property/records", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationDatapointSnapshotResponse/shape/object/property/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationDatapointSnapshotResponse/shape/object/property/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationDatapointSnapshotResponse/shape/object/property/total", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationResponse/shape/object/property/records", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationResponse/shape/object/property/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationResponse/shape/object/property/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationResponse/shape/object/property/total", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataLogResponse/shape/object/property/records", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataLogResponse/shape/object/property/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataLogResponse/shape/object/property/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataLogResponse/shape/object/property/total", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataProjectResponse/shape/object/property/records", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataProjectResponse/shape/object/property/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataProjectResponse/shape/object/property/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataProjectResponse/shape/object/property/total", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataSessionResponse/shape/object/property/records", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataSessionResponse/shape/object/property/page", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataSessionResponse/shape/object/property/size", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataSessionResponse/shape/object/property/total", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PlatformAccessEnum/shape/enum/value/superadmin", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PlatformAccessEnum/shape/enum/value/supportadmin", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PlatformAccessEnum/shape/enum/value/user", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/project_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/project_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/last_used", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/num_datapoints", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/evaluation_aggregates", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object/property/config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectInputResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/active_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/users", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/data_count", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/feedback_types", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/team_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/config_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/active_evaluators", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/directory_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectSortBy/shape/enum/value/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectSortBy/shape/enum/value/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectSortBy/shape/enum/value/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectUserResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectUserResponse/shape/object/property/email_address", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectUserResponse/shape/object/property/full_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/openai", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/ai21", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/mock", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/anthropic", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/bedrock", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/cohere", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/openai_azure", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object/property/openai_azure_endpoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Type/shape/enum/value/json_object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Type/shape/enum/value/json_schema", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ResponseFormat/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ResponseFormat/shape/object/property/json_schema", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionProjectResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionProjectResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionProjectResponse/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/reference_id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/projects", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/datapoints_count", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/first_inputs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/last_output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/created_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object/property/updated_at", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SortOrder/shape/enum/value/asc", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SortOrder/shape/enum/value/desc", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TextChatContent/shape/object/property/text", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TimeUnit/shape/enum/value/day", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TimeUnit/shape/enum/value/week", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TimeUnit/shape/enum/value/month", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolCall/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolCall/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolCall/shape/object/property/function", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolChoice/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolChoice/shape/object/property/function", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/strict", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/parameters", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/source_code", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object/property/preset_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/other", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/created_by", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/source_code", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/setup_schema", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/parameters", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/signature", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/is_preset", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object/property/preset_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse/shape/object/property/description", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse/shape/object/property/parameters", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse/shape/object/property/source", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResultResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResultResponse/shape/object/property/name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResultResponse/shape/object/property/signature", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResultResponse/shape/object/property/result", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolSource/shape/enum/value/organization", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolSource/shape/enum/value/inline", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UpdateLogRequest/shape/object/property/output", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UpdateLogRequest/shape/object/property/error", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UpdateLogRequest/shape/object/property/duration", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Usage/shape/object/property/prompt_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Usage/shape/object/property/generation_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Usage/shape/object/property/total_tokens", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UserResponse/shape/object/property/id", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UserResponse/shape/object/property/email_address", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UserResponse/shape/object/property/full_name", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UserResponse/shape/object/property/verified", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationError/shape/object/property/loc", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationError/shape/object/property/msg", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationError/shape/object/property/type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:VersionStatus/shape/enum/value/uncommitted", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:VersionStatus/shape/enum/value/committed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:VersionStatus/shape/enum/value/deleted", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment_stream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment_stream/response/stream/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.delete/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/error/0/422/error/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCallContentItem/shape/discriminatedUnion/variant/text", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCallContentItem/shape/discriminatedUnion/variant/image_url", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigResponse/shape/discriminatedUnion/variant/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigResponse/shape/discriminatedUnion/variant/tool", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigResponse/shape/discriminatedUnion/variant/evaluator", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigResponse/shape/discriminatedUnion/variant/agent", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigResponse/shape/discriminatedUnion/variant/generic", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypes/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Config/shape/discriminatedUnion/variant/model", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Config/shape/discriminatedUnion/variant/tool", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/request/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CategoricalFeedbackLabel/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointsByLogsRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateLogResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateSessionResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DashboardConfiguration/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationDatapointSnapshotResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackLabelRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModel/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionTool/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionToolChoice/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:HTTPValidationError/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageChatContent/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrl/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigEvaluatorAggregateResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataDatapointResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationDatapointSnapshotResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataLogResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataProjectResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataSessionResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectInputResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectUserResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ResponseFormat/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionProjectResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TextChatContent/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolCall/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolChoice/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResultResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UpdateLogRequest/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Usage/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UserResponse/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationError/shape/object", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_datasets:Request/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_evaluations:CreateEvaluationResultLogRequestResult/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestStop/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestToolsItem/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ModelConfigsSerializeRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Content/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponseToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatRole/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Value/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationStatus/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorArgumentsType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorReturnTypeEnum/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackValue/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackClass/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestValue/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseValue/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModelType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypes", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FileType/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrlDetail/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LabelSentiment/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Judgment/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequestFeedback/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponseToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestStop/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestToolsItem/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequestStop/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestStop/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestToolsItem/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponseStop/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelEndpoints/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ObservabilityStatus/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PlatformAccessEnum/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectSortBy/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Type/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SortOrder/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TimeUnit/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolSource/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationErrorLocItem/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:VersionStatus/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment_stream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment_stream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/example/2", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment_stream/response", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment_stream/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.delete/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.delete/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.delete/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/error/0/422", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/example/0", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete/example/1", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy/request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateStreamRequestToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateRequestToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedStreamRequestToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateDeployedRequestToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigStreamRequestToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_chats:ChatsCreateConfigRequestToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_datasets:Request", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_evaluations:CreateEvaluationResultLogRequestResult", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_feedback:FeedbackFeedbackResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_logs:LogsLogResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestStop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ProjectModelConfigRequestToolsItem", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_modelConfigs:ModelConfigsSerializeRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CategoricalFeedbackLabel/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCallContentItem/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Content", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponseToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatRole", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequestTargetValue", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointsByLogsRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateLogResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateSessionResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DashboardConfiguration/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponseTargetValue", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationDatapointSnapshotResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Value", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationStatus", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorArgumentsType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorReturnTypeEnum", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackValue", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackClass", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackLabelRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequestValue", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponseValue", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModelType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModel/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FileType", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionTool/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:HTTPValidationError/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageChatContent/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrlDetail", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrl/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LabelSentiment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Judgment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Config/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequestFeedback", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponseToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestStop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequestToolsItem", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequestStop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigEvaluatorAggregateResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestStop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequestToolsItem", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponseStop", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelEndpoints", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelProviders", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ObservabilityStatus", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataDatapointResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationDatapointSnapshotResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataLogResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataProjectResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataSessionResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PlatformAccessEnum", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectInputResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectSortBy", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectUserResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ResponseFormat/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionProjectResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SortOrder", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TextChatContent/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TimeUnit", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolCall/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolChoice/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResultResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolSource", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UpdateLogRequest/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Usage/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UserResponse/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationErrorLocItem", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationError/shape", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:VersionStatus", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:AgentConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CategoricalFeedbackLabel", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatDataResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCallContentItem", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatMessageWithToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ChatResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CompletionResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateDatapointsByLogsRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateLogResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:CreateSessionResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DashboardConfiguration", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DataResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatapointResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:DatasetResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentProjectConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EnvironmentRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationDatapointSnapshotResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluationResultResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:EvaluatorResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Feedback", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackLabelRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FeedbackTypeModel", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionTool", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:FunctionToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GenericConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:GetModelConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:HTTPValidationError", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageChatContent", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ImageUrl", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LinkedToolRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:LogResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigChatRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigCompletionRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigEvaluatorAggregateResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ModelConfigToolRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataDatapointResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationDatapointSnapshotResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataEvaluationResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataLogResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataProjectResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:PaginatedDataSessionResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectInputResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProjectUserResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ProviderApiKeys", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ResponseFormat", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionProjectResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:SessionResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:TextChatContent", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolCall", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolChoice", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolConfigResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ToolResultResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UpdateLogRequest", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:Usage", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:UserResponse", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/type-definition/type_:ValidationError", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.createStream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed_stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_deployed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config_stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment_stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_chats.create_experiment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.createStream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed_stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_deployed", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config_stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_config", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment_stream", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_completions.create_experiment", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.update", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datapoints.delete", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_datasets", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_evaluations", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.delete", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.list_configs", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.create_feedback_type", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.update_feedback_types", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects.export", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.delete", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.update", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.list_datapoints", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_datasets.create_datapoint", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list_datapoints", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.create", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.log", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.result", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.update_status", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.add_evaluators", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluations.list", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.list", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.create", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.delete", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_evaluators.update", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_feedback.feedback", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.list", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.log", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.delete", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update_by_ref", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_logs.update", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.register", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.export", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.serialize", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_modelConfigs.deserialize", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.list", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.create", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_sessions.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.get", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/activeConfig.deactivate", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.list", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.deploy", + "8099ff24-8ade-48d5-a54a-8d2d1831d806/endpoint/endpoint_projects/deployedConfig.delete" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-d8feb9f1-c5b3-4935-9375-ad1f1826d72d.json b/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-d8feb9f1-c5b3-4935-9375-ad1f1826d72d.json new file mode 100644 index 0000000000..8b4f615476 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitionKeys-d8feb9f1-c5b3-4935-9375-ad1f1826d72d.json @@ -0,0 +1,2484 @@ +[ + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/evaluation_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/output_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/prompt_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/output_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/prompt_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/output_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/finish_reason", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/tool_choice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/prompt", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/path/log_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/output_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/prompt_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/output_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/prompt_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/output_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/finish_reason", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/tool_choice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/tool_choice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/prompt", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/provider_api_keys", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/num_samples", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/stream", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/return_inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/logprobs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object/property/suffix", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/tool_choice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/prompt", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/provider_api_keys", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/num_samples", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/stream", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/return_inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/logprobs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object/property/suffix", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/2/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/2/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/2/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/3/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/3/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/3/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/query/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/query/user_filter", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/query/sort_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/query/order", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/model", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/endpoint", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/template", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/provider", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/max_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/temperature", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/top_p", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/stop", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/presence_penalty", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/frequency_penalty", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/other", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/seed", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/response_format", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/tools", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/linked_tools", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/request/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/query/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/query/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/path/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object/property/tool", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/path/log_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/query/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/query/user_filter", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/query/sort_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/query/order", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/function", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/source_code", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/setup_values", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/tool_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/request/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/query/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/query/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/path/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/query/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/query/user_filter", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/query/sort_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/query/order", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request/object/property/datapoints", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request/object/property/action", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/2/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/2/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/2/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/query/include_datapoints", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/request/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/query/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/path/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/request/formdata/field/file/file/file", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/request/formdata/field/commit_message/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/query/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/query/user_filter", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/query/sort_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/query/order", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/request/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/request/object/property/spec", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/request/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/query/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/query/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/path/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/judgment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object/property/spec", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/request/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/request/object/property/directory_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/query/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/query/user_filter", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/query/sort_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/query/order", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/request/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/request/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/evaluation_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/trace_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/flow", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object/property/trace_status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/path/log_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/request/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/request/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/request/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/request/object/property/trace_status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/query/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/query/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/path/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/path/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/query/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/query/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/query/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/query/sort_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/query/order", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/query/file_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/request/object/property/dataset", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/request/object/property/evaluatees", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/request/object/property/evaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/request/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/request/object/property/file", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/request/object/property/dataset", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/request/object/property/evaluatees", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/request/object/property/evaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/request/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/request/object/property/file", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/request/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/file_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/version_status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/search", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/metadata_search", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/start_date", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/end_date", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/include_parent", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/query/in_trace_filter", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/query/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/path/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/0/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/0/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/0/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/1/snippet/curl/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/1/snippet/python/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/1/snippet/typescript/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogUpdateRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogUpdateRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogUpdateRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogUpdateRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallStreamRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallStreamRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallStreamRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallStreamRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallRequestToolChoice/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallRequestToolChoice/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallRequestToolChoice/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallRequestToolChoice/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestTemplate/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestTemplate/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestStop/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestStop/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestJudgment/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestJudgment/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestJudgment/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestJudgment/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestSpec/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestSpec/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestSpec/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestSpec/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object/property/evaluator_version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object/property/total_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object/property/num_judgments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object/property/num_nulls", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object/property/num_errors", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object/property/num_true", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object/property/num_false", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContentItem/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContentItem/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContent/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContent/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage/shape/object/property/content", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage/shape/object/property/tool_call_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage/shape/object/property/role", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage/shape/object/property/tool_calls", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatRole/shape/enum/value/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatRole/shape/enum/value/assistant", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatRole/shape/enum/value/system", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatRole/shape/enum/value/tool", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest/shape/object/property/arguments_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest/shape/object/property/return_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest/shape/object/property/evaluator_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest/shape/object/property/code", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CommitRequest/shape/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/4", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue/shape/undiscriminatedUnion/variant/5", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequest/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequest/shape/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequest/shape/object/property/target", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateEvaluatorLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateEvaluatorLogResponse/shape/object/property/parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateEvaluatorLogResponse/shape/object/property/session_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateEvaluatorLogResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateFlowLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateFlowLogResponse/shape/object/property/flow_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateFlowLogResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateFlowLogResponse/shape/object/property/trace_status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreatePromptLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreatePromptLogResponse/shape/object/property/prompt_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreatePromptLogResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreatePromptLogResponse/shape/object/property/session_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateToolLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateToolLogResponse/shape/object/property/tool_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateToolLogResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateToolLogResponse/shape/object/property/session_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DashboardConfiguration/shape/object/property/time_unit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DashboardConfiguration/shape/object/property/time_range_days", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DashboardConfiguration/shape/object/property/model_config_ids", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/4", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue/shape/undiscriminatedUnion/variant/5", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponse/shape/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponse/shape/object/property/target", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/directory_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/environments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/created_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/last_used_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/datapoints_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/datapoints", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentResponse/shape/object/property/tag", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentTag/shape/enum/value/default", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentTag/shape/enum/value/other", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatedVersionResponse/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatedVersionResponse/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatedVersionResponse/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatedVersionResponse/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape/object/property/file_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape/object/property/batch_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape/object/property/orchestrated", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeResponse/shape/object/property/version", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeResponse/shape/object/property/batch_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeResponse/shape/object/property/orchestrated", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationEvaluatorResponse/shape/object/property/version", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationEvaluatorResponse/shape/object/property/orchestrated", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationReportLogResponse/shape/object/property/evaluated_version", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationReportLogResponse/shape/object/property/datapoint", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationReportLogResponse/shape/object/property/log", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationReportLogResponse/shape/object/property/evaluator_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/dataset", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/evaluatees", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/evaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/file_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/created_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object/property/url", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats/shape/object/property/overall_stats", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats/shape/object/property/version_stats", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats/shape/object/property/progress", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats/shape/object/property/report", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats/shape/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStatus/shape/enum/value/pending", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStatus/shape/enum/value/running", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStatus/shape/enum/value/completed", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStatus/shape/enum/value/cancelled", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestActivateItem/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestActivateItem/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestDeactivateItem/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestDeactivateItem/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequest/shape/object/property/activate", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequest/shape/object/property/deactivate", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate/shape/object/property/value", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate/shape/object/property/evaluator_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate/shape/object/property/evaluator_version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorArgumentsType/shape/enum/value/target_free", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorArgumentsType/shape/enum/value/target_required", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentNumberLimit/shape/object/property/min", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentNumberLimit/shape/object/property/max", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentNumberLimit/shape/object/property/step", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentOptionResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentOptionResponse/shape/object/property/valence", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponseJudgment/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponseJudgment/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponseJudgment/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponseJudgment/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/judgment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/evaluator_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/trace_flow_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/trace_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/trace_children", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/evaluator", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object/property/parent", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponseSpec/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponseSpec/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponseSpec/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponseSpec/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/directory_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/spec", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/environments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/created_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/last_used_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/version_logs_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/total_logs_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/evaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/boolean", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/number", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/select", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/multi_select", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorReturnTypeEnum/shape/enum/value/text", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ExternalEvaluatorRequest/shape/object/property/arguments_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ExternalEvaluatorRequest/shape/object/property/return_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ExternalEvaluatorRequest/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ExternalEvaluatorRequest/shape/object/property/evaluator_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponseFile/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponseFile/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponseFile/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponseFile/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponseFile/shape/undiscriminatedUnion/variant/4", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse/shape/object/property/tag", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse/shape/object/property/file", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileRequest/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileRequest/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileType/shape/enum/value/prompt", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileType/shape/enum/value/tool", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileType/shape/enum/value/dataset", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileType/shape/enum/value/evaluator", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileType/shape/enum/value/flow", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowKernelRequest/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/evaluator_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/trace_flow_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/trace_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/trace_children", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/flow", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object/property/trace_status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/directory_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/environments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/created_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/last_used_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/version_logs_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object/property/evaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionTool/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionTool/shape/object/property/arguments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionToolChoice/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HttpValidationError/shape/object/property/detail", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequestReturnType/shape/enum/value/select", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequestReturnType/shape/enum/value/multi_select", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequestReturnType/shape/enum/value/text", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequestReturnType/shape/enum/value/number", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequestReturnType/shape/enum/value/boolean", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/arguments_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/return_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/evaluator_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/instructions", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/options", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/number_limits", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object/property/number_valence", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageChatContent/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageChatContent/shape/object/property/image_url", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrlDetail/shape/enum/value/high", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrlDetail/shape/enum/value/low", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrlDetail/shape/enum/value/auto", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrl/shape/object/property/url", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrl/shape/object/property/detail", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:InputResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest/shape/object/property/arguments_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest/shape/object/property/return_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest/shape/object/property/evaluator_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest/shape/object/property/prompt", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape/object/property/description", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape/object/property/strict", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape/object/property/parameters", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListDatasets/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListEvaluators/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListFlows/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListPrompts/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListTools/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LogResponse/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LogResponse/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LogResponse/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LogResponse/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelEndpoints/shape/enum/value/complete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelEndpoints/shape/enum/value/chat", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelEndpoints/shape/enum/value/edit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/openai", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/openai_azure", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/mock", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/anthropic", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/bedrock", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/cohere", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/replicate", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/google", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape/enum/value/groq", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorEnvironmentRequest/shape/object/property/evaluator_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorEnvironmentRequest/shape/object/property/environment_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse/shape/object/property/version_reference", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse/shape/object/property/version", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse/shape/object/property/state", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorState/shape/enum/value/active", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorState/shape/enum/value/inactive", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorVersionRequest/shape/object/property/evaluator_version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/evaluator_version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/total_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/num_judgments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/num_nulls", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/num_errors", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/mean", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/std", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object/property/percentiles", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ObservabilityStatus/shape/enum/value/pending", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ObservabilityStatus/shape/enum/value/running", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ObservabilityStatus/shape/enum/value/completed", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ObservabilityStatus/shape/enum/value/failed", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:OverallStats/shape/object/property/num_datapoints", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:OverallStats/shape/object/property/total_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:OverallStats/shape/object/property/total_evaluator_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatapointResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatapointResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatapointResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatapointResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatasetResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatasetResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatasetResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatasetResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluationReportLogResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluationReportLogResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluationReportLogResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluationReportLogResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedEvaluationResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedEvaluationResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedEvaluationResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedEvaluationResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluatorResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluatorResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluatorResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluatorResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataFlowResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataFlowResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataFlowResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataFlowResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataLogResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataLogResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataLogResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataLogResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataPromptResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataPromptResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataPromptResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataPromptResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataToolResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataToolResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataToolResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataToolResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem/shape/undiscriminatedUnion/variant/4", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse/shape/object/property/records", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse/shape/object/property/page", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse/shape/object/property/size", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse/shape/object/property/total", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PlatformAccessEnum/shape/enum/value/superadmin", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PlatformAccessEnum/shape/enum/value/supportadmin", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PlatformAccessEnum/shape/enum/value/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProjectSortBy/shape/enum/value/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProjectSortBy/shape/enum/value/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProjectSortBy/shape/enum/value/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/output_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/prompt_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/output_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/prompt_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/output_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/finish_reason", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object/property/index", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponseToolChoice/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponseToolChoice/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponseToolChoice/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponseToolChoice/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/tool_choice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/prompt", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/trace_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object/property/logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/output_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/prompt_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/output_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/prompt_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/output_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/finish_reason", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/index", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/prompt_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestTemplate/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestTemplate/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestStop/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestStop/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/model", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/endpoint", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/template", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/provider", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/max_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/temperature", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/top_p", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/stop", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/presence_penalty", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/frequency_penalty", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/other", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/seed", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/response_format", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/tools", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/linked_tools", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponseToolChoice/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponseToolChoice/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponseToolChoice/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponseToolChoice/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/output_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/prompt_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/output_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/prompt_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/output_cost", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/finish_reason", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/messages", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/tool_choice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/prompt", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/evaluator_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/trace_flow_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/trace_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object/property/trace_children", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseTemplate/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseTemplate/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseStop/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseStop/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/directory_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/model", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/endpoint", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/template", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/provider", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/max_tokens", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/temperature", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/top_p", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/stop", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/presence_penalty", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/frequency_penalty", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/other", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/seed", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/response_format", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/tools", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/linked_tools", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/environments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/created_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/last_used_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/version_logs_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/total_logs_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/evaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object/property/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/openai", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/ai21", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/mock", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/anthropic", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/bedrock", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/cohere", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/openai_azure", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object/property/openai_azure_endpoint", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormatType/shape/enum/value/json_object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormatType/shape/enum/value/json_schema", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormat/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormat/shape/object/property/json_schema", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape/object/property/evaluator_version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape/object/property/total_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape/object/property/num_judgments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape/object/property/num_nulls", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape/object/property/num_errors", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape/object/property/num_judgments_per_option", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SortOrder/shape/enum/value/asc", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SortOrder/shape/enum/value/desc", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextChatContent/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextChatContent/shape/object/property/text", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse/shape/object/property/evaluator_version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse/shape/object/property/total_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse/shape/object/property/num_judgments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse/shape/object/property/num_nulls", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse/shape/object/property/num_errors", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TimeUnit/shape/enum/value/day", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TimeUnit/shape/enum/value/week", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TimeUnit/shape/enum/value/month", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolCall/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolCall/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolCall/shape/object/property/function", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolChoice/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolChoice/shape/object/property/function", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolFunction/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolFunction/shape/object/property/description", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolFunction/shape/object/property/strict", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolFunction/shape/object/property/parameters", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolKernelRequest/shape/object/property/function", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolKernelRequest/shape/object/property/source_code", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolKernelRequest/shape/object/property/setup_values", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolKernelRequest/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/start_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/end_time", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/output", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/error", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/provider_latency", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/stdout", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/provider_request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/provider_response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/source", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/metadata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/source_datapoint_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/trace_parent_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/batches", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/user", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/save", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/evaluator_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/trace_flow_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/trace_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/trace_children", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object/property/tool", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/directory_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/function", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/source_code", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/setup_values", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/attributes", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/tool_type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/name", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/environments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/created_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/updated_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/created_by", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/status", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/last_used_at", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/version_logs_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/total_logs_count", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/inputs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/evaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/signature", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object/property/evaluator_aggregates", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TraceStatus/shape/enum/value/complete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TraceStatus/shape/enum/value/incomplete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UpdateDatesetAction/shape/enum/value/set", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UpdateDatesetAction/shape/enum/value/add", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UpdateDatesetAction/shape/enum/value/remove", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:Valence/shape/enum/value/positive", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:Valence/shape/enum/value/negative", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:Valence/shape/enum/value/neutral", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationError/shape/object/property/loc", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationError/shape/object/property/msg", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationError/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponseFile/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponseFile/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponseFile/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponseFile/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponseFile/shape/undiscriminatedUnion/variant/4", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponse/shape/object/property/file", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponse/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponse/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponseVersion/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponseVersion/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponseVersion/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponseVersion/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponseVersion/shape/undiscriminatedUnion/variant/4", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponse/shape/object/property/version", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponse/shape/object/property/type", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionReferenceResponse/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionReferenceResponse/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponseEvaluatorVersionStatsItem/shape/undiscriminatedUnion/variant/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponseEvaluatorVersionStatsItem/shape/undiscriminatedUnion/variant/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponseEvaluatorVersionStatsItem/shape/undiscriminatedUnion/variant/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponseEvaluatorVersionStatsItem/shape/undiscriminatedUnion/variant/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponse/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponse/shape/object/property/num_logs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponse/shape/object/property/evaluator_version_stats", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatus/shape/enum/value/uncommitted", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatus/shape/enum/value/committed", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatus/shape/enum/value/deleted", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType/shape/enum/value/pinecone_search", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType/shape/enum/value/google", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType/shape/enum/value/mock", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType/shape/enum/value/snippet", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType/shape/enum/value/json_schema", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType/shape/enum/value/get_api_call", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsDatasetRequest/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsDatasetRequest/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsDatasetRequest/shape/object/property/file_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsDatasetRequest/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest/shape/object/property/version_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest/shape/object/property/path", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest/shape/object/property/file_id", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest/shape/object/property/environment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest/shape/object/property/orchestrated", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/response/stream/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/error/0/422/error/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UserResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatToolType/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:AgentConfigResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorConfigResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UpdateEvaluationStatusRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedPromptLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedSessionResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ConfigToolResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FeedbackType/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BaseModelsUserResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/request/formdata/field/file", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/request/formdata/field/commit_message", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/request/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CommitRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateEvaluatorLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateFlowLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreatePromptLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateToolLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DashboardConfiguration/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationEvaluatorResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationReportLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentNumberLimit/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentOptionResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ExternalEvaluatorRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowKernelRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionTool/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionToolChoice/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HttpValidationError/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageChatContent/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrl/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:InputResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListDatasets/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListEvaluators/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListFlows/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListPrompts/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListTools/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorEnvironmentRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorVersionRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:OverallStats/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatapointResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatasetResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluationReportLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedEvaluationResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluatorResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataFlowResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataPromptResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataToolResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormat/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextChatContent/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolCall/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolChoice/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolFunction/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolKernelRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationError/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponse/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsDatasetRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest/shape/object", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogRequestToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogUpdateRequestToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallStreamRequestToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallRequestToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestTemplate/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestStop/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestJudgment/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestSpec/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContentItem/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContent/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatRole/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentTag/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatedVersionResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStatus/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestActivateItem/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestDeactivateItem/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorArgumentsType/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponseJudgment/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponseSpec/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorReturnTypeEnum/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponseFile/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileType/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequestReturnType/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrlDetail/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelEndpoints/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorState/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ObservabilityStatus/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PlatformAccessEnum/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProjectSortBy/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponseToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestTemplate/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestStop/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponseToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseTemplate/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseStop/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormatType/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SortOrder/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TimeUnit/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TraceStatus/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UpdateDatesetAction/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UserResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:Valence/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationErrorLocItem/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponseFile/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponseVersion/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionReferenceResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponseEvaluatorVersionStatsItem/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatus/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatToolType", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UpdateEvaluationStatusRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedPromptLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedSessionResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ConfigToolResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FeedbackType", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BaseModelsUserResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/response", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/example/3", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/example/2", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/error/0/422", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/0", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get/example/1", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:AgentConfigResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorConfigResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/request/formdata", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogRequestToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptLogUpdateRequestToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallStreamRequestToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptsCallRequestToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestTemplate", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_prompts:PromptRequestStop", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestJudgment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_evaluators:CreateEvaluatorLogRequestSpec", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContentItem", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessageContent", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatRole", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CommitRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequestTargetValue", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateEvaluatorLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateFlowLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreatePromptLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateToolLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DashboardConfiguration/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponseTargetValue", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentTag", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatedVersionResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationEvaluatorResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationReportLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStatus", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestActivateItem", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequestDeactivateItem", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorArgumentsType", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentNumberLimit/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentOptionResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponseJudgment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponseSpec", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorReturnTypeEnum", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ExternalEvaluatorRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponseFile", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileType", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowKernelRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionTool/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HttpValidationError/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequestReturnType", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageChatContent/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrlDetail", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrl/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:InputResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListDatasets/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListEvaluators/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListFlows/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListPrompts/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListTools/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelEndpoints", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ModelProviders", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorEnvironmentRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorState", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorVersionRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ObservabilityStatus", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:OverallStats/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatapointResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatasetResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluationReportLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedEvaluationResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluatorResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataFlowResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataPromptResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataToolResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PlatformAccessEnum", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProjectSortBy", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponseToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestTemplate", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequestStop", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponseToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseTemplate", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponseStop", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormatType", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormat/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SortOrder", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextChatContent/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TimeUnit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolCall/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolChoice/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolFunction/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolKernelRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TraceStatus", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:UpdateDatesetAction", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:Valence", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationErrorLocItem", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationError/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponseFile", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponseVersion", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionReferenceResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponseEvaluatorVersionStatsItem", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponse/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatus", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FilesToolType", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsDatasetRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest/shape", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:AgentConfigResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorConfigResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:BooleanEvaluatorStatsResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ChatMessage", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CodeEvaluatorRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CommitRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateDatapointRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateEvaluatorLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateFlowLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreatePromptLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:CreateToolLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DashboardConfiguration", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatapointResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:DatasetResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EnvironmentResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluateeResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationEvaluatorResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationReportLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationStats", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorActivationDeactivationRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorAggregate", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentNumberLimit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorJudgmentOptionResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluatorResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ExternalEvaluatorRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileEnvironmentResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FileRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowKernelRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FlowResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionTool", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:FunctionToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HttpValidationError", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:HumanEvaluatorRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageChatContent", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ImageUrl", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:InputResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LlmEvaluatorRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:LinkedToolResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListDatasets", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListEvaluators", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListFlows", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListPrompts", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ListTools", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorEnvironmentRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:MonitoringEvaluatorVersionRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:NumericEvaluatorStatsResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:OverallStats", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatapointResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDatasetResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluationReportLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedEvaluationResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataEvaluatorResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataFlowResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataPromptResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataToolResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptCallStreamResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptKernelRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:PromptResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ProviderApiKeys", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ResponseFormat", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:SelectEvaluatorStatsResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextChatContent", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:TextEvaluatorStatsResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolCall", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolChoice", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolFunction", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolKernelRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolLogResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ToolResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:ValidationError", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionDeploymentResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionIdResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:VersionStatsResponse", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsDatasetRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/type-definition/type_:EvaluationsRequest", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.log", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.update", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call_stream", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.call", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.upsert", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.get", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.delete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.move", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listVersions", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.commit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.updateMonitoring", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.setDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.removeDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_prompts.listEnvironments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.log", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.update", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.upsert", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.get", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.delete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.move", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listVersions", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.commit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.updateMonitoring", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.setDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.removeDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_tools.listEnvironments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.upsert", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.get", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.delete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.move", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listDatapoints", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listVersions", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.commit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv/request", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.setDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.removeDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.listEnvironments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.upsert", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.get", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.delete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.move", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listVersions", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.commit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.setDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.removeDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.listEnvironments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluators.log", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.get", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.delete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.move", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.upsert", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.log", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateLog", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listVersions", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.commit", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.setDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.removeDeployment", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.listEnvironments", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_flows.updateMonitoring", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_files.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.create", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.get", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.delete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateSetup", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.updateStatus", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getStats", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_evaluations.getLogs", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.list", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.delete", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_logs.get", + "d8feb9f1-c5b3-4935-9375-ad1f1826d72d/endpoint/endpoint_datasets.uploadCsv" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitions.json new file mode 100644 index 0000000000..b8582524f7 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/humanloop/apiDefinitions.json @@ -0,0 +1,78452 @@ +[ + { + "id": "8099ff24-8ade-48d5-a54a-8d2d1831d806", + "endpoints": { + "endpoint_chats.createStream": { + "id": "endpoint_chats.createStream", + "namespace": [ + "subpackage_chats" + ], + "description": "Get a chat response by providing details of the model configuration in the request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateStreamRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateStreamRequestToolCall" + } + }, + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "availability": "Deprecated" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "model_config", + "valueShape": { + "type": "id", + "id": "type_:ModelConfigChatRequest" + }, + "description": "The model configuration used to create a chat response." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/chat", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "messages": [ + { + "role": "user" + } + ], + "model_config": { + "model": "string" + } + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ],\n \"model_config\": {\n \"model\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/chat", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "messages": [ + { + "role": "user" + } + ], + "model_config": { + "model": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ],\n \"model_config\": {\n \"model\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.create": { + "id": "endpoint_chats.create", + "namespace": [ + "subpackage_chats" + ], + "description": "Get a chat response by providing details of the model configuration in the request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateRequestToolCall" + } + }, + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "availability": "Deprecated" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "model_config", + "valueShape": { + "type": "id", + "id": "type_:ModelConfigChatRequest" + }, + "description": "The model configuration used to create a chat response." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/chat", + "responseStatusCode": 200, + "name": "Simple", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "messages": [ + { + "role": "user", + "content": "What really happened at Roswell?" + } + ], + "model_config": { + "model": "gpt-4o", + "max_tokens": 200, + "chat_template": [ + { + "role": "system", + "content": "You are {{person}}. Answer any questions as this person. Do not break character." + } + ] + }, + "project": "persona", + "inputs": { + "person": "Trump" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "data_fIfEb1SoKZooqeFbi9IFs", + "index": 0, + "output": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time. People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!", + "raw_output": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time. People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!", + "model_config_id": "prv_Wu6zx1lAWJRqOyL8nWuZk", + "output_message": { + "role": "assistant", + "content": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time. People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!" + }, + "inputs": { + "person": "Trump" + }, + "finish_reason": "stop", + "tool_results": [], + "messages": [ + { + "role": "system", + "content": "You are Trump. Answer any questions as this person. Do not break character." + }, + { + "role": "user", + "content": "What really happened at Roswell?" + } + ] + } + ], + "provider_responses": [ + { + "id": "chatcmpl-9TbTAC1WFnAlRNY3yzVGGPQbLOXFY", + "choices": [ + { + "finish_reason": "stop", + "index": 0, + "message": { + "content": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time. People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!", + "role": "assistant" + } + } + ], + "created": 1716842572, + "model": "gpt-4o-2024-05-13", + "object": "chat.completion", + "system_fingerprint": "fp_43dfabdef1", + "usage": { + "completion_tokens": 125, + "prompt_tokens": 34, + "total_tokens": 159 + } + } + ], + "project_id": "pr_3usCu3dAkgrXTlufrvPs7", + "num_samples": 1, + "usage": { + "prompt_tokens": 34, + "generation_tokens": 125, + "total_tokens": 159 + }, + "provider_request": { + "messages": [ + { + "content": "You are Trump. Answer any questions as this person. Do not break character.", + "role": "system" + }, + { + "content": "What really happened at Roswell?", + "role": "user" + } + ], + "stream": false, + "n": 1, + "model": "gpt-4o", + "temperature": 1, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "max_tokens": 200 + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What really happened at Roswell?\"\n }\n ],\n \"model_config\": {\n \"model\": \"gpt-4o\",\n \"max_tokens\": 200,\n \"chat_template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are {{person}}. Answer any questions as this person. Do not break character.\"\n }\n ]\n },\n \"project\": \"persona\",\n \"inputs\": {\n \"person\": \"Trump\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/chat", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "messages": [ + { + "role": "user" + } + ], + "model_config": { + "model": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ],\n \"model_config\": {\n \"model\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.create_deployed_stream": { + "id": "endpoint_chats.create_deployed_stream", + "namespace": [ + "subpackage_chats" + ], + "description": "Get a chat response using the project's active deployment.\n\nThe active deployment can be a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat-deployed" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateDeployedStreamRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateDeployedStreamRequestToolCall" + } + }, + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "availability": "Deprecated" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment name used to create a chat response. If not specified, the default environment will be used." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/chat-deployed", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "messages": [ + { + "role": "user" + } + ] + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/chat-deployed", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "messages": [ + { + "role": "user" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.create_deployed": { + "id": "endpoint_chats.create_deployed", + "namespace": [ + "subpackage_chats" + ], + "description": "Get a chat response using the project's active deployment.\n\nThe active deployment can be a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat-deployed" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateDeployedRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateDeployedRequestToolCall" + } + }, + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "availability": "Deprecated" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment name used to create a chat response. If not specified, the default environment will be used." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/chat-deployed", + "responseStatusCode": 200, + "name": "ai-assistant-with-tools", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "messages": [ + { + "role": "user", + "content": "What is the weather in SF?" + } + ], + "project": "ai-assistant", + "inputs": { + "persona": "helpful but will *always* tell a joke first before calling tools" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "data_lwWadasRw0vT4XDarZuNQ", + "index": 0, + "output": "Why did the weather report go to school? To become a little brighter!\n\nLet me check the current weather in San Francisco for you.", + "raw_output": "Why did the weather report go to school? To become a little brighter!\n\nLet me check the current weather in San Francisco for you.", + "model_config_id": "prv_rlwVnPhRsiMKfnTusferP", + "output_message": { + "role": "assistant", + "content": "Why did the weather report go to school? To become a little brighter!\n\nLet me check the current weather in San Francisco for you.", + "tool_calls": [ + { + "id": "call_1b6yHTGiB51P2I75T6yZrm63", + "type": "function", + "function": { + "name": "get_current_weather", + "arguments": "{\"location\":\"San Francisco, CA\"}" + } + } + ] + }, + "inputs": { + "persona": "helpful but will *always* tell a joke first before calling tools" + }, + "finish_reason": "tool_call", + "tool_results": [], + "messages": [ + { + "role": "system", + "content": "You are a helpful assistant with persona helpful but will *always* tell a joke first before calling tools. \nUse tools to respond to user's queries.\n" + }, + { + "role": "user", + "content": "What is the weather in SF?" + } + ], + "tool_calls": [ + { + "id": "call_1b6yHTGiB51P2I75T6yZrm63", + "type": "function", + "function": { + "name": "get_current_weather", + "arguments": "{\"location\":\"San Francisco, CA\"}" + } + } + ], + "tool_call": { + "name": "get_current_weather", + "arguments": "{\"location\":\"San Francisco, CA\"}" + } + } + ], + "provider_responses": [ + { + "id": "chatcmpl-9TbcxkvnK9Q0VTCO89GGPsgWiI7LY", + "choices": [ + { + "finish_reason": "tool_calls", + "index": 0, + "message": { + "content": "Why did the weather report go to school? To become a little brighter!\n\nLet me check the current weather in San Francisco for you.", + "role": "assistant", + "tool_calls": [ + { + "id": "call_1b6yHTGiB51P2I75T6yZrm63", + "function": { + "arguments": "{\"location\":\"San Francisco, CA\"}", + "name": "get_current_weather" + }, + "type": "function" + } + ] + } + } + ], + "created": 1716843179, + "model": "gpt-4o-2024-05-13", + "object": "chat.completion", + "system_fingerprint": "fp_43dfabdef1", + "usage": { + "completion_tokens": 46, + "prompt_tokens": 137, + "total_tokens": 183 + } + } + ], + "project_id": "pr_TfhDgggIsPi3cgmhq2yeA", + "num_samples": 1, + "usage": { + "prompt_tokens": 137, + "generation_tokens": 46, + "total_tokens": 183 + }, + "provider_request": { + "messages": [ + { + "content": "You are a helpful assistant with persona helpful but will *always* tell a joke first before calling tools. \nUse tools to respond to user's queries.\n", + "role": "system" + }, + { + "content": "What is the weather in SF?", + "role": "user" + } + ], + "stream": false, + "n": 1, + "model": "gpt-4o", + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "name": "Location", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "name": "Unit", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + }, + { + "type": "function", + "function": { + "name": "get_stock_price", + "description": "Get current stock price", + "parameters": { + "type": "object", + "properties": { + "ticker_symbol": { + "type": "string", + "name": "Ticker Symbol", + "description": "Ticker symbol of the stock" + } + }, + "required": [] + } + } + } + ], + "tool_choice": "auto" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What is the weather in SF?\"\n }\n ],\n \"project\": \"ai-assistant\",\n \"inputs\": {\n \"persona\": \"helpful but will *always* tell a joke first before calling tools\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/chat-deployed", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "messages": [ + { + "role": "user" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.create_config_stream": { + "id": "endpoint_chats.create_config_stream", + "namespace": [ + "subpackage_chats" + ], + "description": "Get chat response for a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat-model-config" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateConfigStreamRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateConfigStreamRequestToolCall" + } + }, + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "availability": "Deprecated" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "model_config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifies the model configuration used to create a chat response." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/chat-model-config", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "messages": [ + { + "role": "user" + } + ], + "model_config_id": "string" + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ],\n \"model_config_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/chat-model-config", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "messages": [ + { + "role": "user" + } + ], + "model_config_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ],\n \"model_config_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.create_config": { + "id": "endpoint_chats.create_config", + "namespace": [ + "subpackage_chats" + ], + "description": "Get chat response for a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat-model-config" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateConfigRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_chats:ChatsCreateConfigRequestToolCall" + } + }, + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "availability": "Deprecated" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "model_config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifies the model configuration used to create a chat response." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/chat-model-config", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "messages": [ + { + "role": "user" + } + ], + "model_config_id": "model_config_id" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "index": 1, + "output": "output", + "raw_output": "raw_output", + "model_config_id": "model_config_id", + "output_message": { + "role": "user" + }, + "inputs": { + "key": "value" + }, + "finish_reason": "finish_reason", + "tool_results": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "messages": [ + { + "role": "user" + } + ], + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "provider_responses": [ + { + "key": "value" + } + ], + "project_id": "project_id", + "num_samples": 1, + "logprobs": 1, + "suffix": "suffix", + "user": "user", + "usage": { + "prompt_tokens": 1, + "generation_tokens": 1, + "total_tokens": 1 + }, + "metadata": { + "key": "value" + }, + "provider_request": { + "key": "value" + }, + "session_id": "session_id", + "tool_choice": "none" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ],\n \"model_config_id\": \"model_config_id\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/chat-model-config", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "messages": [ + { + "role": "user" + } + ], + "model_config_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"messages\": [\n {\n \"role\": \"user\"\n }\n ],\n \"model_config_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.create_experiment_stream": { + "id": "endpoint_chats.create_experiment_stream", + "namespace": [ + "subpackage_chats" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat-experiment" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + } + }, + "examples": [ + { + "path": "/chat-experiment", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ], + "messages": [ + { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + }, + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ], + "tool_call": { + "name": "string", + "arguments": "string" + } + } + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string", + "tool_choice": "none" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-experiment", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.create_experiment": { + "id": "endpoint_chats.create_experiment", + "namespace": [ + "subpackage_chats" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/chat-experiment" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ChatResponse" + } + } + }, + "examples": [ + { + "path": "/chat-experiment", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "index": 1, + "output": "output", + "raw_output": "raw_output", + "model_config_id": "model_config_id", + "output_message": { + "role": "user" + }, + "inputs": { + "key": "value" + }, + "finish_reason": "finish_reason", + "tool_results": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "messages": [ + { + "role": "user" + } + ], + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "provider_responses": [ + { + "key": "value" + } + ], + "project_id": "project_id", + "num_samples": 1, + "logprobs": 1, + "suffix": "suffix", + "user": "user", + "usage": { + "prompt_tokens": 1, + "generation_tokens": 1, + "total_tokens": 1 + }, + "metadata": { + "key": "value" + }, + "provider_request": { + "key": "value" + }, + "session_id": "session_id", + "tool_choice": "none" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/chat-experiment", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.createStream": { + "id": "endpoint_completions.createStream", + "namespace": [ + "subpackage_completions" + ], + "description": "Create a completion by providing details of the model configuration in the request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "model_config", + "valueShape": { + "type": "id", + "id": "type_:ModelConfigCompletionRequest" + }, + "description": "The model configuration used to generate." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/completion", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "model_config": { + "model": "string" + } + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"model_config\": {\n \"model\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/completion", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "model_config": { + "model": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"model_config\": {\n \"model\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.create": { + "id": "endpoint_completions.create", + "namespace": [ + "subpackage_completions" + ], + "description": "Create a completion by providing details of the model configuration in the request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "model_config", + "valueShape": { + "type": "id", + "id": "type_:ModelConfigCompletionRequest" + }, + "description": "The model configuration used to generate." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/completion", + "responseStatusCode": 200, + "name": "Simple", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "model_config": { + "model": "gpt-4o", + "endpoint": "complete", + "prompt_template": "write a limerick about {{topic}}" + }, + "project": "limerick", + "inputs": { + "topic": "AI" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "data_hdsujCtCep4W5L7XwYpnn", + "index": 0, + "output": "There once was an AI so keen,\nWith circuits and code all pristine.\nIt learned how to chat,\nAnd got clever at that,\nNow it talks like a true human being!", + "raw_output": "There once was an AI so keen,\nWith circuits and code all pristine.\nIt learned how to chat,\nAnd got clever at that,\nNow it talks like a true human being!", + "inputs": { + "topic": "AI" + }, + "model_config_id": "prv_AkObw2O2rquayfWHyJbqw", + "finish_reason": "stop", + "tool_results": [] + } + ], + "provider_responses": [ + { + "id": "chatcmpl-9SY6mNMWrL5gxtyL7xUOTIYZOjguD", + "choices": [ + { + "finish_reason": "stop", + "index": 0, + "message": { + "content": "There once was an AI so keen,\nWith circuits and code all pristine.\nIt learned how to chat,\nAnd got clever at that,\nNow it talks like a true human being!", + "role": "assistant" + } + } + ], + "created": 1716591324, + "model": "gpt-4o-2024-05-13", + "object": "chat.completion", + "system_fingerprint": "fp_3196d36131", + "usage": { + "completion_tokens": 36, + "prompt_tokens": 14, + "total_tokens": 50 + } + } + ], + "project_id": "pr_eJgRt5K1zivoFgHVlRnFv", + "num_samples": 1, + "usage": { + "prompt_tokens": 14, + "generation_tokens": 36, + "total_tokens": 50 + }, + "provider_request": { + "messages": [ + { + "content": "write a limerick about AI", + "role": "user" + } + ], + "stream": false, + "n": 1, + "model": "gpt-4o", + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0 + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"model_config\": {\n \"model\": \"gpt-4o\",\n \"endpoint\": \"complete\",\n \"prompt_template\": \"write a limerick about {{topic}}\"\n },\n \"project\": \"limerick\",\n \"inputs\": {\n \"topic\": \"AI\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/completion", + "responseStatusCode": 200, + "name": "Using ID and session", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "model_config": { + "model": "gpt-4o", + "endpoint": "complete", + "prompt_template": "write a limerick about {{topic}}" + }, + "project_id": "pr_eJgRt5K1zivoFgHVlRnFv", + "session_reference_id": "my_external_session_id", + "inputs": { + "topic": "AI" + }, + "user": "jordan@humanloop.com" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "data_hdsujCtCep4W5L7XwYpnn", + "index": 0, + "output": "There once was an AI so keen,\nWith circuits and code all pristine.\nIt learned how to chat,\nAnd got clever at that,\nNow it talks like a true human being!", + "raw_output": "There once was an AI so keen,\nWith circuits and code all pristine.\nIt learned how to chat,\nAnd got clever at that,\nNow it talks like a true human being!", + "inputs": { + "topic": "AI" + }, + "model_config_id": "prv_AkObw2O2rquayfWHyJbqw", + "finish_reason": "stop", + "tool_results": [] + } + ], + "provider_responses": [ + { + "id": "chatcmpl-9SY6mNMWrL5gxtyL7xUOTIYZOjguD", + "choices": [ + { + "finish_reason": "stop", + "index": 0, + "message": { + "content": "There once was an AI so keen,\nWith circuits and code all pristine.\nIt learned how to chat,\nAnd got clever at that,\nNow it talks like a true human being!", + "role": "assistant" + } + } + ], + "created": 1716591324, + "model": "gpt-4o-2024-05-13", + "object": "chat.completion", + "system_fingerprint": "fp_3196d36131", + "usage": { + "completion_tokens": 36, + "prompt_tokens": 14, + "total_tokens": 50 + } + } + ], + "project_id": "pr_eJgRt5K1zivoFgHVlRnFv", + "num_samples": 1, + "user": "jordan@humanloop.com", + "usage": { + "prompt_tokens": 14, + "generation_tokens": 36, + "total_tokens": 50 + }, + "provider_request": { + "messages": [ + { + "content": "write a limerick about AI", + "role": "user" + } + ], + "stream": false, + "n": 1, + "model": "gpt-4o", + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "user": "jordan@humanloop.com" + }, + "session_id": "sesh_YuzHoIpqfcs15KoDmfuGb" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"model_config\": {\n \"model\": \"gpt-4o\",\n \"endpoint\": \"complete\",\n \"prompt_template\": \"write a limerick about {{topic}}\"\n },\n \"project_id\": \"pr_eJgRt5K1zivoFgHVlRnFv\",\n \"session_reference_id\": \"my_external_session_id\",\n \"inputs\": {\n \"topic\": \"AI\"\n },\n \"user\": \"jordan@humanloop.com\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/completion", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "model_config": { + "model": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"model_config\": {\n \"model\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.create_deployed_stream": { + "id": "endpoint_completions.create_deployed_stream", + "namespace": [ + "subpackage_completions" + ], + "description": "Create a completion using the project's active deployment.\n\nThe active deployment can be a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion-deployed" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment name used to create a chat response. If not specified, the default environment will be used." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/completion-deployed", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/completion-deployed", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.create_deployed": { + "id": "endpoint_completions.create_deployed", + "namespace": [ + "subpackage_completions" + ], + "description": "Create a completion using the project's active deployment.\n\nThe active deployment can be a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion-deployed" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment name used to create a chat response. If not specified, the default environment will be used." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/completion-deployed", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "index": 1, + "output": "output", + "raw_output": "raw_output", + "inputs": { + "key": "value" + }, + "model_config_id": "model_config_id", + "finish_reason": "finish_reason", + "tool_results": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ] + } + ], + "provider_responses": [ + { + "key": "value" + } + ], + "project_id": "project_id", + "num_samples": 1, + "logprobs": 1, + "suffix": "suffix", + "user": "user", + "usage": { + "prompt_tokens": 1, + "generation_tokens": 1, + "total_tokens": 1 + }, + "metadata": { + "key": "value" + }, + "provider_request": { + "key": "value" + }, + "session_id": "session_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false\n}'", + "generated": true + } + ] + } + }, + { + "path": "/completion-deployed", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-deployed \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.create_config_stream": { + "id": "endpoint_completions.create_config_stream", + "namespace": [ + "subpackage_completions" + ], + "description": "Create a completion for a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion-model-config" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "model_config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifies the model configuration used to create a chat response." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/completion-model-config", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "model_config_id": "string" + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"model_config_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/completion-model-config", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true, + "model_config_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true,\n \"model_config_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.create_config": { + "id": "endpoint_completions.create_config", + "namespace": [ + "subpackage_completions" + ], + "description": "Create a completion for a specific model configuration.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion-model-config" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Deprecated field: the seed is instead set as part of the request.config object.", + "availability": "Deprecated" + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "model_config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifies the model configuration used to create a chat response." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/completion-model-config", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "model_config_id": "model_config_id" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "index": 1, + "output": "output", + "raw_output": "raw_output", + "inputs": { + "key": "value" + }, + "model_config_id": "model_config_id", + "finish_reason": "finish_reason", + "tool_results": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ] + } + ], + "provider_responses": [ + { + "key": "value" + } + ], + "project_id": "project_id", + "num_samples": 1, + "logprobs": 1, + "suffix": "suffix", + "user": "user", + "usage": { + "prompt_tokens": 1, + "generation_tokens": 1, + "total_tokens": 1 + }, + "metadata": { + "key": "value" + }, + "provider_request": { + "key": "value" + }, + "session_id": "session_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"model_config_id\": \"model_config_id\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/completion-model-config", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "model_config_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-model-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"model_config_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.create_experiment_stream": { + "id": "endpoint_completions.create_experiment_stream", + "namespace": [ + "subpackage_completions" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion-experiment" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + } + }, + "examples": [ + { + "path": "/completion-experiment", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "stream", + "value": [ + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + }, + { + "project_id": "string", + "num_samples": 0, + "logprobs": 0, + "suffix": "string", + "user": "string", + "data": [ + { + "id": "string", + "index": 0, + "output": "string", + "raw_output": "string", + "inputs": { + "string": {} + }, + "finish_reason": "string", + "model_config_id": "string", + "tool_results": [ + { + "id": "string", + "name": "string", + "signature": "string", + "result": "string" + } + ] + } + ], + "usage": { + "prompt_tokens": 0, + "generation_tokens": 0, + "total_tokens": 0 + }, + "metadata": { + "string": {} + }, + "provider_responses": [ + {} + ], + "provider_request": { + "string": {} + }, + "session_id": "string" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-experiment", + "generated": true + } + ] + } + } + ] + }, + "endpoint_completions.create_experiment": { + "id": "endpoint_completions.create_experiment", + "namespace": [ + "subpackage_completions" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/completion-experiment" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CompletionResponse" + } + } + }, + "examples": [ + { + "path": "/completion-experiment", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "index": 1, + "output": "output", + "raw_output": "raw_output", + "inputs": { + "key": "value" + }, + "model_config_id": "model_config_id", + "finish_reason": "finish_reason", + "tool_results": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ] + } + ], + "provider_responses": [ + { + "key": "value" + } + ], + "project_id": "project_id", + "num_samples": 1, + "logprobs": 1, + "suffix": "suffix", + "user": "user", + "usage": { + "prompt_tokens": 1, + "generation_tokens": 1, + "total_tokens": 1 + }, + "metadata": { + "key": "value" + }, + "provider_request": { + "key": "value" + }, + "session_id": "session_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/completion-experiment", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datapoints.get": { + "id": "endpoint_datapoints.get", + "namespace": [ + "subpackage_datapoints" + ], + "description": "Get a datapoint by ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datapoints/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of datapoint." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatapointResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datapoints/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "dataset_id": "dataset_id", + "inputs": { + "key": "value" + }, + "messages": [ + { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "target": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/datapoints/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/datapoints/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/datapoints/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datapoints.update": { + "id": "endpoint_datapoints.update", + "namespace": [ + "subpackage_datapoints" + ], + "description": "Edit the input, messages and criteria fields of a datapoint.\n\nWARNING: This endpoint has been decommissioned and no longer works. Please use the v5 datasets API instead.", + "availability": "Deprecated", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/datapoints/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of datapoint." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatapointResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datapoints/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "dataset_id": "dataset_id", + "inputs": { + "key": "value" + }, + "messages": [ + { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "target": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/datapoints/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/datapoints/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/datapoints/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datapoints.delete": { + "id": "endpoint_datapoints.delete", + "namespace": [ + "subpackage_datapoints" + ], + "description": "Delete a list of datapoints by their IDs.\n\nWARNING: This endpoint has been decommissioned and no longer works. Please use the v5 datasets API instead.", + "availability": "Deprecated", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/datapoints" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datapoints", + "responseStatusCode": 204, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/datapoints \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/datapoints", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/datapoints \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.list_datasets": { + "id": "endpoint_projects.list_datasets", + "namespace": [ + "subpackage_projects" + ], + "description": "Get all datasets for a project.", + "availability": "Deprecated", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "project_id" + }, + { + "type": "literal", + "value": "/datasets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/project_id/datasets", + "responseStatusCode": 200, + "pathParameters": { + "project_id": "project_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/project_id/datasets \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:project_id/datasets", + "responseStatusCode": 422, + "pathParameters": { + "project_id": ":project_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/:project_id/datasets \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.list_evaluations": { + "id": "endpoint_projects.list_evaluations", + "namespace": [ + "subpackage_projects" + ], + "description": "Get all the evaluations associated with your project.\n\nDeprecated: This is a legacy unpaginated endpoint. Use `/evaluations` instead, with appropriate\nsorting, filtering and pagination options.", + "availability": "Deprecated", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "project_id" + }, + { + "type": "literal", + "value": "/evaluations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "queryParameters": [ + { + "key": "evaluatee_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with `evv_`." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to include evaluator aggregates in the response." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/project_id/evaluations", + "responseStatusCode": 200, + "pathParameters": { + "project_id": "project_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "status": "pending", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "dataset": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "dataset_version_id": "dataset_version_id", + "dataset_snapshot": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "evaluator_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/project_id/evaluations \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:project_id/evaluations", + "responseStatusCode": 422, + "pathParameters": { + "project_id": ":project_id" + }, + "queryParameters": { + "evaluatee_id": "string", + "evaluator_aggregates": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/projects/:project_id/evaluations \\\n -H \"X-API-KEY: \" \\\n -d evaluatee_id=string \\\n -d evaluator_aggregates=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.list": { + "id": "endpoint_projects.list", + "namespace": [ + "subpackage_projects" + ], + "description": "Get a paginated list of files.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/projects" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page offset for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of projects to fetch." + }, + { + "key": "filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for project name." + }, + { + "key": "user_filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for users in the project. This filter matches against both email address and name of users." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectSortBy" + } + }, + "description": "Field to sort projects by" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortOrder" + } + }, + "description": "Direction to sort by." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataProjectResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + } + }, + "config_type": "generic", + "active_evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "directory_id": "directory_id" + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/projects \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.create": { + "id": "endpoint_projects.create", + "namespace": [ + "subpackage_projects" + ], + "description": "Create a new project.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/projects" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique project name." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of directory to assign project to. Starts with `dir_`. If not provided, the project will be created in the root directory." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ProjectResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "name" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating", + "values": [ + { + "value": "value", + "sentiment": "positive" + } + ] + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + }, + "config_type": "generic", + "active_evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + } + } + ], + "directory_id": "directory_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"name\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/projects", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.get": { + "id": "endpoint_projects.get", + "namespace": [ + "subpackage_projects" + ], + "description": "Get a specific project.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ProjectResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating", + "values": [ + { + "value": "value", + "sentiment": "positive" + } + ] + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + }, + "config_type": "generic", + "active_evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + } + } + ], + "directory_id": "directory_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.delete": { + "id": "endpoint_projects.delete", + "namespace": [ + "subpackage_projects" + ], + "description": "Delete a specific file.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/projects/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/projects/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.update": { + "id": "endpoint_projects.update", + "namespace": [ + "subpackage_projects" + ], + "description": "Update a specific project.\n\nSet the project's active model config by passing `active_model_config_id`.\nThese will be set to the Default environment unless a list of environments\nare also passed in specifically detailing which environments to assign the\nactive config.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The new unique project name. Caution, if you are using the project name as the unique identifier in your API calls, changing the name will break the calls." + }, + { + "key": "active_config_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for a config to set as the project's active deployment. Starts with 'config_'. " + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of directory to assign project to. Starts with `dir_`." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ProjectResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating", + "values": [ + { + "value": "value", + "sentiment": "positive" + } + ] + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + }, + "config_type": "generic", + "active_evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + } + } + ], + "directory_id": "directory_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/projects/id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/projects/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.list_configs": { + "id": "endpoint_projects.list_configs", + "namespace": [ + "subpackage_projects" + ], + "description": "Get an array of versions associated to your file.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/configs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "queryParameters": [ + { + "key": "evaluation_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProjectConfigResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id/configs", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/id/configs \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id/configs", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "evaluation_aggregates": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/projects/:id/configs \\\n -H \"X-API-KEY: \" \\\n -d evaluation_aggregates=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.create_feedback_type": { + "id": "endpoint_projects.create_feedback_type", + "namespace": [ + "subpackage_projects" + ], + "availability": "Deprecated", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/feedback-types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The type of feedback to update." + }, + { + "key": "class", + "valueShape": { + "type": "id", + "id": "type_:FeedbackClass" + }, + "description": "The data type associated to this feedback type; whether it is a 'text'/'select'/'multi_select'." + }, + { + "key": "values", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FeedbackLabelRequest" + } + } + }, + "description": "The feedback values to be available. This field should only be populated when updating a 'select' or 'multi_select' feedback class." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FeedbackTypeModel" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id/feedback-types", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "type", + "class": "select" + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "rating", + "values": [ + { + "value": "value", + "sentiment": "positive" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects/id/feedback-types \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"type\",\n \"class\": \"select\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id/feedback-types", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "type": "string", + "class": "select" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects/:id/feedback-types \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"string\",\n \"class\": \"select\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.update_feedback_types": { + "id": "endpoint_projects.update_feedback_types", + "namespace": [ + "subpackage_projects" + ], + "description": "Update feedback types.\n\nWARNING: This endpoint has been decommissioned and no longer works. Please use the v5 Human Evaluators API instead.", + "availability": "Deprecated", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/feedback-types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id/feedback-types", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "key": "value" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/projects/id/feedback-types \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id/feedback-types", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/projects/:id/feedback-types \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects.export": { + "id": "endpoint_projects.export", + "namespace": [ + "subpackage_projects" + ], + "description": "Export all logged datapoints associated to your project.\n\nResults are paginated and sorts the datapoints based on `created_at` in\ndescending order.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/export" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page offset for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of logs to export." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id/export", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + }, + "evaluation_results": [ + { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z" + } + ], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z", + "project": "project", + "project_id": "project_id", + "session_id": "session_id", + "session_reference_id": "session_reference_id", + "parent_id": "parent_id", + "parent_reference_id": "parent_reference_id", + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "save": true, + "source_datapoint_id": "source_datapoint_id", + "reference_id": "reference_id", + "messages": [ + { + "role": "user" + } + ], + "output": "output", + "judgment": true, + "config_id": "config_id", + "environment": "environment", + "feedback": [ + { + "type": "rating", + "value": true, + "id": "id" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "stdout": "stdout", + "duration": 1.1, + "output_message": { + "role": "user" + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "user": "user", + "provider_latency": 1.1, + "tokens": 1, + "raw_output": "raw_output", + "finish_reason": "finish_reason", + "tools": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "tool_choice": "none", + "batch_ids": [ + "batch_ids" + ] + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects/id/export \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id/export", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v4/projects/:id/export?page=0&size=0\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.create": { + "id": "endpoint_datasets.create", + "namespace": [ + "subpackage_datasets" + ], + "description": "Create a new dataset for a project.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "project_id" + }, + { + "type": "literal", + "value": "/datasets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the dataset." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The description of the dataset." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/project_id/datasets", + "responseStatusCode": 200, + "pathParameters": { + "project_id": "project_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "name", + "description": "description" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects/project_id/datasets \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"name\",\n \"description\": \"description\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/projects/:project_id/datasets", + "responseStatusCode": 422, + "pathParameters": { + "project_id": ":project_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "description": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects/:project_id/datasets \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"description\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.list": { + "id": "endpoint_datasets.list", + "namespace": [ + "subpackage_datasets" + ], + "description": "Get all Datasets for an organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/datasets \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/datasets", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/datasets \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.get": { + "id": "endpoint_datasets.get", + "namespace": [ + "subpackage_datasets" + ], + "description": "Get a single dataset by ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of dataset. Starts with `evts_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/datasets/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/datasets/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.delete": { + "id": "endpoint_datasets.delete", + "namespace": [ + "subpackage_datasets" + ], + "description": "Delete a dataset by ID.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of dataset. Starts with `evts_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "key": "value" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/datasets/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/datasets/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.update": { + "id": "endpoint_datasets.update", + "namespace": [ + "subpackage_datasets" + ], + "description": "Update a testset by ID.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of testset. Starts with `evts_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the dataset." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the dataset." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/datasets/id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/datasets/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.list_datapoints": { + "id": "endpoint_datasets.list_datapoints", + "namespace": [ + "subpackage_datasets" + ], + "description": "Get datapoints for a dataset.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "dataset_id" + }, + { + "type": "literal", + "value": "/datapoints" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "dataset_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of dataset. Starts with `evts_`." + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataDatapointResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/dataset_id/datapoints", + "responseStatusCode": 200, + "pathParameters": { + "dataset_id": "dataset_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "id", + "dataset_id": "dataset_id", + "inputs": { + "key": "value" + }, + "messages": [ + { + "role": "user" + } + ], + "target": { + "key": "value" + } + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/datasets/dataset_id/datapoints \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:dataset_id/datapoints", + "responseStatusCode": 422, + "pathParameters": { + "dataset_id": ":dataset_id" + }, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/datasets/:dataset_id/datapoints \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.create_datapoint": { + "id": "endpoint_datasets.create_datapoint", + "namespace": [ + "subpackage_datasets" + ], + "description": "Create a new datapoint for a dataset.\n\nHere in the v4 API, this has the following behaviour:\n\n- Retrieve the current latest version of the dataset.\n- Construct a new version of the dataset with the new testcases added.\n- Store that latest version as a committed version with an autogenerated commit\n message and return the new datapoints", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "dataset_id" + }, + { + "type": "literal", + "value": "/datapoints" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "dataset_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of dataset. Starts with `evts_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_datasets:Request" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatapointResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/dataset_id/datapoints", + "responseStatusCode": 200, + "pathParameters": { + "dataset_id": "dataset_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "log_ids": [ + "log_ids" + ] + } + }, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "dataset_id": "dataset_id", + "inputs": { + "key": "value" + }, + "messages": [ + { + "role": "user" + } + ], + "target": { + "key": "value" + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/datasets/dataset_id/datapoints \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"log_ids\": [\n \"log_ids\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:dataset_id/datapoints", + "responseStatusCode": 422, + "pathParameters": { + "dataset_id": ":dataset_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "log_ids": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/datasets/:dataset_id/datapoints \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"log_ids\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.get": { + "id": "endpoint_evaluations.get", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Get evaluation by ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of evaluation run. Starts with `ev_`." + } + ], + "queryParameters": [ + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to include evaluator aggregates in the response." + }, + { + "key": "evaluatee_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with `evv_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "status": "pending", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + } + ], + "dataset": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "dataset_version_id": "dataset_version_id", + "dataset_snapshot": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "evaluator_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "aggregate_value": 1.1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/evaluations/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "evaluator_aggregates": true, + "evaluatee_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/evaluations/:id \\\n -H \"X-API-KEY: \" \\\n -d evaluator_aggregates=true \\\n -d evaluatee_id=string", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.list_datapoints": { + "id": "endpoint_evaluations.list_datapoints", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Get testcases by evaluation ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/datapoints" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of evaluation. Starts with `ev_`." + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page to fetch. Starts from 1." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of evaluation results to retrieve." + }, + { + "key": "evaluatee_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with `evv_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataEvaluationDatapointSnapshotResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/id/datapoints", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "datapoint": { + "id": "id" + }, + "evaluation_results": [ + { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z" + } + ], + "log": { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + }, + "evaluation_results": [ + { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z" + } + ], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z" + } + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/evaluations/id/datapoints \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id/datapoints", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/evaluations/:id/datapoints \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.create": { + "id": "endpoint_evaluations.create", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Create an evaluation.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "project_id" + }, + { + "type": "literal", + "value": "/evaluations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the config to evaluate. Starts with `config_`." + }, + { + "key": "evaluator_ids", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "IDs of evaluators to run on the dataset. IDs start with `evfn_`" + }, + { + "key": "dataset_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the dataset to use in this evaluation. Starts with `evts_`." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization. Ensure you provide an API key for the provider for the model config you are evaluating, or have one saved to your organization." + }, + { + "key": "hl_generated", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the log generations for this evaluation should be performed by Humanloop. If `False`, the log generations should be submitted by the user via the API." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Evaluation to help identify it." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/project_id/evaluations", + "responseStatusCode": 200, + "pathParameters": { + "project_id": "project_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "config_id": "config_id", + "evaluator_ids": [ + "evaluator_ids" + ], + "dataset_id": "dataset_id" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "status": "pending", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + } + ], + "dataset": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "dataset_version_id": "dataset_version_id", + "dataset_snapshot": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "evaluator_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "aggregate_value": 1.1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects/project_id/evaluations \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"config_id\": \"config_id\",\n \"evaluator_ids\": [\n \"evaluator_ids\"\n ],\n \"dataset_id\": \"dataset_id\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/projects/:project_id/evaluations", + "responseStatusCode": 422, + "pathParameters": { + "project_id": ":project_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "config_id": "string", + "evaluator_ids": [ + "string" + ], + "dataset_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/projects/:project_id/evaluations \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"config_id\": \"string\",\n \"evaluator_ids\": [\n \"string\"\n ],\n \"dataset_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.log": { + "id": "endpoint_evaluations.log", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Log an external generation to an evaluation run for a datapoint.\n\nThe run must have status 'running'.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "evaluation_id" + }, + { + "type": "literal", + "value": "/log" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "evaluation_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the evaluation run. Starts with `evrun_`." + } + ], + "queryParameters": [ + { + "key": "evaluatee_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with `evv_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "datapoint_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The datapoint for which a log was generated. Must be one of the datapoints in the dataset being evaluated." + }, + { + "key": "log", + "valueShape": { + "type": "id", + "id": "type_:LogRequest" + }, + "description": "The log generated for the datapoint." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/evaluation_id/log", + "responseStatusCode": 200, + "pathParameters": { + "evaluation_id": "evaluation_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "datapoint_id": "datapoint_id", + "log": {} + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "project_id": "project_id", + "session_id": "session_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/evaluations/evaluation_id/log \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"datapoint_id\": \"datapoint_id\",\n \"log\": {}\n}'", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:evaluation_id/log", + "responseStatusCode": 422, + "pathParameters": { + "evaluation_id": ":evaluation_id" + }, + "queryParameters": { + "evaluatee_id": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "datapoint_id": "string", + "log": {} + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v4/evaluations/:evaluation_id/log?evaluatee_id=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"datapoint_id\": \"string\",\n \"log\": {}\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.result": { + "id": "endpoint_evaluations.result", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Log an evaluation result to an evaluation run.\n\nThe run must have status 'running'. One of `result` or `error` must be provided.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "evaluation_id" + }, + { + "type": "literal", + "value": "/result" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "evaluation_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the evaluation run. Starts with `evrun_`." + } + ], + "queryParameters": [ + { + "key": "evaluatee_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with `evv_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "log_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The log that was evaluated. Must have as its `source_datapoint_id` one of the datapoints in the dataset being evaluated." + }, + { + "key": "evaluator_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the evaluator that evaluated the log. Starts with `evfn_`. Must be one of the evaluator IDs associated with the evaluation run being logged to." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_evaluations:CreateEvaluationResultLogRequestResult" + } + }, + "description": "The result value of the evaluation." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An error that occurred during evaluation." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResultResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/evaluation_id/result", + "responseStatusCode": 200, + "pathParameters": { + "evaluation_id": "evaluation_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "log_id": "log_id", + "evaluator_id": "evaluator_id" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z", + "evaluation_id": "evaluation_id", + "log": { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "evaluation_results": [], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z", + "project": "project", + "project_id": "project_id", + "session_id": "session_id", + "session_reference_id": "session_reference_id", + "parent_id": "parent_id", + "parent_reference_id": "parent_reference_id", + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "save": true, + "source_datapoint_id": "source_datapoint_id", + "reference_id": "reference_id", + "messages": [ + { + "role": "user" + } + ], + "output": "output", + "judgment": true, + "config_id": "config_id", + "environment": "environment", + "feedback": [ + { + "type": "rating", + "value": true, + "id": "id" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "stdout": "stdout", + "duration": 1.1, + "output_message": { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "user": "user", + "provider_latency": 1.1, + "tokens": 1, + "raw_output": "raw_output", + "finish_reason": "finish_reason", + "tools": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "tool_choice": "none", + "batch_ids": [ + "batch_ids" + ] + }, + "version_id": "version_id", + "version": { + "key": "value" + }, + "value": true, + "error": "error", + "evaluator_log": { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "evaluation_results": [], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z", + "project": "project", + "project_id": "project_id", + "session_id": "session_id", + "session_reference_id": "session_reference_id", + "parent_id": "parent_id", + "parent_reference_id": "parent_reference_id", + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "save": true, + "source_datapoint_id": "source_datapoint_id", + "reference_id": "reference_id", + "messages": [ + { + "role": "user" + } + ], + "output": "output", + "judgment": true, + "config_id": "config_id", + "environment": "environment", + "feedback": [ + { + "type": "rating", + "value": true, + "id": "id" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "stdout": "stdout", + "duration": 1.1, + "output_message": { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "user": "user", + "provider_latency": 1.1, + "tokens": 1, + "raw_output": "raw_output", + "finish_reason": "finish_reason", + "tools": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "tool_choice": "none", + "batch_ids": [ + "batch_ids" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/evaluations/evaluation_id/result \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"log_id\": \"log_id\",\n \"evaluator_id\": \"evaluator_id\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:evaluation_id/result", + "responseStatusCode": 422, + "pathParameters": { + "evaluation_id": ":evaluation_id" + }, + "queryParameters": { + "evaluatee_id": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "log_id": "string", + "evaluator_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v4/evaluations/:evaluation_id/result?evaluatee_id=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"log_id\": \"string\",\n \"evaluator_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.update_status": { + "id": "endpoint_evaluations.update_status", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Update the status of an evaluation run.\n\nCan only be used to update the status of an evaluation run that uses external or human evaluators.\nThe evaluation must currently have status 'running' if swithcing to completed, or it must have status\n'completed' if switching back to 'running'.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of evaluation run. Starts with `ev_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:EvaluationStatus" + }, + "description": "The new status of the evaluation." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/id/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "status": "pending" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "status": "pending", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + } + ], + "dataset": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "dataset_version_id": "dataset_version_id", + "dataset_snapshot": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "evaluator_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "aggregate_value": 1.1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/evaluations/id/status \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"status\": \"pending\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id/status", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "status": "pending" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/evaluations/:id/status \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"status\": \"pending\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.add_evaluators": { + "id": "endpoint_evaluations.add_evaluators", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Add evaluators to an existing evaluation run.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of evaluation run. Starts with `ev_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluator_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "IDs of evaluators to add to the evaluation run. IDs start with `evfn_`" + }, + { + "key": "evaluator_version_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "IDs of the evaluator versions to add to the evaluation run. IDs start with `evv_`" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/id/evaluators", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "status": "pending", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + } + ], + "dataset": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "dataset_version_id": "dataset_version_id", + "dataset_snapshot": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id", + "description": "description" + }, + "evaluator_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "aggregate_value": 1.1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/evaluations/id/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id/evaluators", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/evaluations/:id/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluations.list": { + "id": "endpoint_evaluations.list", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Get the evaluations associated with a project.\n\nSorting and filtering are supported through query params for categorical columns\nand the `created_at` timestamp.\n\nSorting is supported for the `dataset`, `config`, `status` and `evaluator-{evaluator_id}` columns.\nSpecify sorting with the `sort` query param, with values `{column}.{ordering}`.\nE.g. ?sort=dataset.asc&sort=status.desc will yield a multi-column sort. First by dataset then by status.\n\nFiltering is supported for the `id`, `dataset`, `config` and `status` columns.\n\nSpecify filtering with the `id_filter`, `dataset_filter`, `config_filter` and `status_filter` query params.\n\nE.g. ?dataset_filter=my_dataset&dataset_filter=my_other_dataset&status_filter=running\nwill only show rows where the dataset is \"my_dataset\" or \"my_other_dataset\", and where the status is \"running\".\n\nAn additional date range filter is supported for the `created_at` column. Use the `start_date` and `end_date`\nquery parameters to configure this.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "queryParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A list of evaluation run ids to filter on. Starts with `ev_`." + }, + { + "key": "start_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Only return evaluations created after this date." + }, + { + "key": "end_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Only return evaluations created before this date." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "evaluatee_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of evaluatee version to return. If not defined, the first evaluatee will be returned. Starts with `evv_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataEvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "project_id": "project_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "id", + "status": "pending", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + }, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "dataset": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id" + }, + "dataset_version_id": "dataset_version_id", + "dataset_snapshot": { + "id": "id", + "name": "name", + "datapoint_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "project_id": "project_id" + }, + "evaluator_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/evaluations \\\n -H \"X-API-KEY: \" \\\n -d project_id=project_id", + "generated": true + } + ] + } + }, + { + "path": "/evaluations", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "project_id": "string", + "id": "string", + "start_date": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/evaluations \\\n -H \"X-API-KEY: \" \\\n -d project_id=string \\\n -d id=string \\\n -d start_date=string", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluators.list": { + "id": "endpoint_evaluators.list", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Get all evaluators within your organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model", + "other": { + "key": "value" + }, + "name": "name", + "description": "description", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "seed": 1, + "response_format": { + "type": "json_object" + }, + "prompt_template": "prompt_template", + "chat_template": [ + { + "role": "user" + } + ], + "tools": [ + { + "id": "id", + "name": "name" + } + ], + "endpoint": "complete", + "tool_configs": [ + { + "id": "id", + "status": "status", + "name": "name" + } + ] + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + } + }, + "config_type": "generic", + "directory_id": "directory_id" + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/evaluators \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/evaluators", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/evaluators \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluators.create": { + "id": "endpoint_evaluators.create", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Create an evaluator within your organization.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1 + } + }, + "description": "The name of the evaluator." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The description of the evaluator." + }, + { + "key": "arguments_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + }, + "description": "Whether this evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorReturnTypeEnum" + }, + "description": "The type of the return value of the evaluator." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The code for the evaluator. This code will be executed in a sandboxed environment." + }, + { + "key": "model_config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigCompletionRequest" + } + }, + "description": "The model configuration used to generate." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorType" + }, + "description": "The type of the evaluator." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python" + } + }, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model", + "other": { + "key": "value" + }, + "name": "name", + "description": "description", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "prompt_template": "prompt_template", + "chat_template": [ + { + "role": "user" + } + ], + "tools": [ + { + "id": "id", + "name": "name" + } + ], + "endpoint": "complete", + "tool_configs": [ + { + "id": "id", + "status": "status", + "name": "name" + } + ] + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + }, + "config_type": "generic", + "directory_id": "directory_id" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"name\",\n \"description\": \"description\",\n \"arguments_type\": \"target_free\",\n \"return_type\": \"boolean\",\n \"type\": \"python\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/evaluators", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "description": "string", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"description\": \"string\",\n \"arguments_type\": \"target_free\",\n \"return_type\": \"boolean\",\n \"type\": \"python\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluators.get": { + "id": "endpoint_evaluators.get", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Get an evaluator within your organization.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model", + "other": { + "key": "value" + }, + "name": "name", + "description": "description", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "prompt_template": "prompt_template", + "chat_template": [ + { + "role": "user" + } + ], + "tools": [ + { + "id": "id", + "name": "name" + } + ], + "endpoint": "complete", + "tool_configs": [ + { + "id": "id", + "status": "status", + "name": "name" + } + ] + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + }, + "config_type": "generic", + "directory_id": "directory_id" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/evaluators/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/evaluators/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluators.delete": { + "id": "endpoint_evaluators.delete", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Delete an evaluator within your organization.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/evaluators/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/evaluators/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_evaluators.update": { + "id": "endpoint_evaluators.update", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Update an evaluator within your organization.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the evaluator." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the evaluator." + }, + { + "key": "arguments_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + } + }, + "description": "Whether this evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluatorReturnTypeEnum" + } + }, + "description": "The type of the return value of the evaluator." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The code for the evaluator. This code will be executed in a sandboxed environment." + }, + { + "key": "model_config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigCompletionRequest" + } + }, + "description": "The model configuration used to generate." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model", + "other": { + "key": "value" + }, + "name": "name", + "description": "description", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "prompt_template": "prompt_template", + "chat_template": [ + { + "role": "user" + } + ], + "tools": [ + { + "id": "id", + "name": "name" + } + ], + "endpoint": "complete", + "tool_configs": [ + { + "id": "id", + "status": "status", + "name": "name" + } + ] + }, + "logging_project": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating" + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + }, + "config_type": "generic", + "directory_id": "directory_id" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/evaluators/id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/evaluators/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_feedback.feedback": { + "id": "endpoint_feedback.feedback", + "namespace": [ + "subpackage_feedback" + ], + "description": "Submit an array of feedback for existing `data_ids`", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/feedback" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_feedback:FeedbackFeedbackRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_feedback:FeedbackFeedbackResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/feedback", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": [ + { + "type": "rating" + } + ] + }, + "responseBody": { + "type": "json", + "value": [ + { + "type": "rating", + "value": true, + "data_id": "data_id", + "user": "user", + "created_at": "2024-01-15T09:30:00Z", + "id": "id" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/feedback \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n {\n \"type\": \"rating\"\n }\n]'", + "generated": true + } + ] + } + }, + { + "path": "/feedback", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": [ + { + "type": "rating" + } + ] + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/feedback \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n {\n \"type\": \"rating\"\n }\n]'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_logs.list": { + "id": "endpoint_logs.list", + "namespace": [ + "subpackage_logs" + ], + "description": "Retrieve paginated logs from the server.\n\nSorting and filtering are supported through query params.\n\nSorting is supported for the `source`, `model`, `timestamp`, and `feedback-{output_name}` columns.\nSpecify sorting with the `sort` query param, with values `{column}.{ordering}`.\nE.g. ?sort=source.asc&sort=model.desc will yield a multi-column sort. First by source then by model.\n\nFiltering is supported for the `source`, `model`, `feedback-{output_name}`,\n`evaluator-{evaluator_external_id}` columns.\n\nSpecify filtering with the `source_filter`, `model_filter`, `feedback-{output.name}_filter` and\n`evaluator-{evaluator_external_id}_filter` query params.\n\nE.g. `?source_filter=AI&source_filter=user_1234&feedback-explicit_filter=good`\nwill only show rows where the source is \"AI\" or \"user_1234\", and where the latest feedback for the \"explicit\" output\ngroup is \"good\".\n\nAn additional date range filter is supported for the `Timestamp` column (i.e. `Log.created_at`).\nThese are supported through the `start_date` and `end_date` query parameters.\nThe date format could be either date: `YYYY-MM-DD`, e.g. 2024-01-01\nor datetime: YYYY-MM-DD[T]HH:MM[:SS[.ffffff]][Z or [±]HH[:]MM], e.g. 2024-01-01T00:00:00Z.\n\nSearching is supported for the model inputs and output.\nSpecify a search term with the `search` query param.\nE.g. `?search=hello%20there` will cause a case-insensitive search across model inputs and output.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/logs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "queryParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "metadata_search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "version_status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VersionStatus" + } + } + }, + { + "key": "start_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "end_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "project_id": "project_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config" + }, + "evaluation_results": [ + { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z" + } + ], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z", + "project": "project", + "project_id": "project_id", + "session_id": "session_id", + "session_reference_id": "session_reference_id", + "parent_id": "parent_id", + "parent_reference_id": "parent_reference_id", + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "save": true, + "source_datapoint_id": "source_datapoint_id", + "reference_id": "reference_id", + "messages": [ + { + "role": "user" + } + ], + "output": "output", + "judgment": true, + "config_id": "config_id", + "environment": "environment", + "feedback": [ + { + "type": "rating", + "value": true, + "id": "id" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "stdout": "stdout", + "duration": 1.1, + "output_message": { + "role": "user" + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "user": "user", + "provider_latency": 1.1, + "tokens": 1, + "raw_output": "raw_output", + "finish_reason": "finish_reason", + "tools": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "tool_choice": "none", + "batch_ids": [ + "batch_ids" + ] + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/logs \\\n -H \"X-API-KEY: \" \\\n -d project_id=project_id", + "generated": true + } + ] + } + }, + { + "path": "/logs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "project_id": "string", + "search": "string", + "metadata_search": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/logs \\\n -H \"X-API-KEY: \" \\\n -d project_id=string \\\n -d search=string \\\n -d metadata_search=string", + "generated": true + } + ] + } + } + ] + }, + "endpoint_logs.log": { + "id": "endpoint_logs.log", + "namespace": [ + "subpackage_logs" + ], + "description": "Log a datapoint or array of datapoints to your Humanloop project.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/logs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_logs:LogsLogRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_logs:LogsLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": [ + {} + ] + }, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "project_id": "project_id", + "session_id": "session_id" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/logs \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n {}\n]'", + "generated": true + } + ] + } + }, + { + "path": "/logs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": [ + {} + ] + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/logs \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n {}\n]'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_logs.delete": { + "id": "endpoint_logs.delete", + "namespace": [ + "subpackage_logs" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/logs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "queryParameters": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs", + "responseStatusCode": 204, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/logs \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/logs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://api.humanloop.com/v4/logs?id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_logs.update_by_ref": { + "id": "endpoint_logs.update_by_ref", + "namespace": [ + "subpackage_logs" + ], + "description": "Update a logged datapoint by its reference ID.\n\nThe `reference_id` query parameter must be provided, and refers to the\n`reference_id` of a previously-logged datapoint.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/logs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "queryParameters": [ + { + "key": "reference_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A unique string to reference the datapoint. Identifies the logged datapoint created with the same `reference_id`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UpdateLogRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "reference_id": "reference_id" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "evaluation_results": [ + { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z", + "evaluation_id": "evaluation_id", + "version_id": "version_id", + "version": { + "key": "value" + }, + "value": true, + "error": "error" + } + ], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z", + "project": "project", + "project_id": "project_id", + "session_id": "session_id", + "session_reference_id": "session_reference_id", + "parent_id": "parent_id", + "parent_reference_id": "parent_reference_id", + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "save": true, + "source_datapoint_id": "source_datapoint_id", + "reference_id": "reference_id", + "messages": [ + { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "output": "output", + "judgment": true, + "config_id": "config_id", + "environment": "environment", + "feedback": [ + { + "type": "rating", + "value": true, + "id": "id", + "data_id": "data_id", + "user": "user", + "created_at": "2024-01-15T09:30:00Z" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "stdout": "stdout", + "duration": 1.1, + "output_message": { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name", + "arguments": "arguments" + } + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "user": "user", + "provider_latency": 1.1, + "tokens": 1, + "raw_output": "raw_output", + "finish_reason": "finish_reason", + "tools": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "tool_choice": "none", + "batch_ids": [ + "batch_ids" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://api.humanloop.com/v4/logs?reference_id=reference_id\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/logs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "reference_id": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://api.humanloop.com/v4/logs?reference_id=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_logs.get": { + "id": "endpoint_logs.get", + "namespace": [ + "subpackage_logs" + ], + "description": "Retrieve a log by log id.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/logs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of log to return. Starts with `data_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "evaluation_results": [ + { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z", + "evaluation_id": "evaluation_id", + "version_id": "version_id", + "version": { + "key": "value" + }, + "value": true, + "error": "error" + } + ], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z", + "project": "project", + "project_id": "project_id", + "session_id": "session_id", + "session_reference_id": "session_reference_id", + "parent_id": "parent_id", + "parent_reference_id": "parent_reference_id", + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "save": true, + "source_datapoint_id": "source_datapoint_id", + "reference_id": "reference_id", + "messages": [ + { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "output": "output", + "judgment": true, + "config_id": "config_id", + "environment": "environment", + "feedback": [ + { + "type": "rating", + "value": true, + "id": "id", + "data_id": "data_id", + "user": "user", + "created_at": "2024-01-15T09:30:00Z" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "stdout": "stdout", + "duration": 1.1, + "output_message": { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name", + "arguments": "arguments" + } + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "user": "user", + "provider_latency": 1.1, + "tokens": 1, + "raw_output": "raw_output", + "finish_reason": "finish_reason", + "tools": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "tool_choice": "none", + "batch_ids": [ + "batch_ids" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/logs/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/logs/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/logs/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_logs.update": { + "id": "endpoint_logs.update", + "namespace": [ + "subpackage_logs" + ], + "description": "Update a logged datapoint in your Humanloop project.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/logs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of logged datapoint to return. Starts with `data_`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UpdateLogRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "evaluation_results": [ + { + "id": "id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "log_id": "log_id", + "updated_at": "2024-01-15T09:30:00Z", + "created_at": "2024-01-15T09:30:00Z", + "evaluation_id": "evaluation_id", + "version_id": "version_id", + "version": { + "key": "value" + }, + "value": true, + "error": "error" + } + ], + "observability_status": "pending", + "updated_at": "2024-01-15T09:30:00Z", + "project": "project", + "project_id": "project_id", + "session_id": "session_id", + "session_reference_id": "session_reference_id", + "parent_id": "parent_id", + "parent_reference_id": "parent_reference_id", + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "save": true, + "source_datapoint_id": "source_datapoint_id", + "reference_id": "reference_id", + "messages": [ + { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "output": "output", + "judgment": true, + "config_id": "config_id", + "environment": "environment", + "feedback": [ + { + "type": "rating", + "value": true, + "id": "id", + "data_id": "data_id", + "user": "user", + "created_at": "2024-01-15T09:30:00Z" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "stdout": "stdout", + "duration": 1.1, + "output_message": { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name", + "arguments": "arguments" + } + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "user": "user", + "provider_latency": 1.1, + "tokens": 1, + "raw_output": "raw_output", + "finish_reason": "finish_reason", + "tools": [ + { + "id": "id", + "name": "name", + "signature": "signature", + "result": "result" + } + ], + "tool_choice": "none", + "batch_ids": [ + "batch_ids" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/logs/id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/logs/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/logs/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelConfigs.register": { + "id": "endpoint_modelConfigs.register", + "namespace": [ + "subpackage_modelConfigs" + ], + "description": "Register a model config to a project.\n\nIf the project name provided does not exist, a new project will be created\nautomatically.\n\nIf the model config is the first to be associated to the project, it will\nbe set as the active model config.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/model-configs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly display name for the model config. If not provided, a name will be generated." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the model config." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used. E.g. text-davinci-002." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_modelConfigs:ProjectModelConfigRequestStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If it does not exist, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project ID" + }, + { + "key": "prompt_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Prompt template that will take your specified inputs to form your final request to the provider model. NB: Input variables within the prompt template should be specified with syntax: {{INPUT_NAME}}." + }, + { + "key": "chat_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. NB: Input variables within the prompt template should be specified with syntax: {{INPUT_NAME}}." + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "Which of the providers model endpoints to use. For example Complete or Edit." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_modelConfigs:ProjectModelConfigRequestToolsItem" + } + } + }, + "description": "Make tools available to OpenAIs chat model as functions." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ProjectConfigResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/model-configs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "model" + } + }, + "responseBody": { + "type": "json", + "value": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "aggregate_value": 1.1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"model\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/model-configs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelConfigs.get": { + "id": "endpoint_modelConfigs.get", + "namespace": [ + "subpackage_modelConfigs" + ], + "description": "Get a specific model config by ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/model-configs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of the model config. Starts with `config_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelConfigResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/model-configs/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "model": "model", + "other": { + "key": "value" + }, + "name": "name", + "description": "description", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "prompt_template": "prompt_template", + "chat_template": [ + { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "tools": [ + { + "id": "id", + "name": "name", + "description": "description", + "parameters": { + "key": "value" + }, + "source": "source" + } + ], + "endpoint": "complete", + "tool_configs": [ + { + "id": "id", + "status": "status", + "name": "name", + "other": { + "key": "value" + }, + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "description", + "source": "organization", + "source_code": "source_code", + "setup_schema": { + "key": "value" + }, + "parameters": { + "key": "value" + }, + "signature": "signature", + "is_preset": true, + "preset_name": "preset_name" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/model-configs/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/model-configs/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/model-configs/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelConfigs.export": { + "id": "endpoint_modelConfigs.export", + "namespace": [ + "subpackage_modelConfigs" + ], + "description": "Export a model config to a .prompt file by ID.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/model-configs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/export" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of the model config. Starts with `config_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/model-configs/id/export", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": "string" + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs/id/export \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/model-configs/:id/export", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs/:id/export \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelConfigs.serialize": { + "id": "endpoint_modelConfigs.serialize", + "namespace": [ + "subpackage_modelConfigs" + ], + "description": "Serialize a model config to a .prompt file format.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/model-configs/serialize" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_modelConfigs:ModelConfigsSerializeRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/model-configs/serialize", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "model" + } + }, + "responseBody": { + "type": "json", + "value": "string" + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs/serialize \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"model\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/model-configs/serialize", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs/serialize \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelConfigs.deserialize": { + "id": "endpoint_modelConfigs.deserialize", + "namespace": [ + "subpackage_modelConfigs" + ], + "description": "Deserialize a model config from a .prompt file format.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/model-configs/deserialize" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "config", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelConfigResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/model-configs/deserialize", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "config": "config" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "model": "model", + "other": { + "key": "value" + }, + "name": "name", + "description": "description", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "prompt_template": "prompt_template", + "chat_template": [ + { + "role": "user", + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ], + "tool_call": { + "name": "name" + } + } + ], + "tools": [ + { + "id": "id", + "name": "name", + "description": "description", + "parameters": { + "key": "value" + }, + "source": "source" + } + ], + "endpoint": "complete", + "tool_configs": [ + { + "id": "id", + "status": "status", + "name": "name", + "other": { + "key": "value" + }, + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "description", + "source": "organization", + "source_code": "source_code", + "setup_schema": { + "key": "value" + }, + "parameters": { + "key": "value" + }, + "signature": "signature", + "is_preset": true, + "preset_name": "preset_name" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs/deserialize \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"config\": \"config\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/model-configs/deserialize", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "config": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/model-configs/deserialize \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"config\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_sessions.list": { + "id": "endpoint_sessions.list", + "namespace": [ + "subpackage_sessions" + ], + "description": "Get a page of sessions.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/sessions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "queryParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project to return sessions for. Sessions that contain any datapoints associated to this project will be returned. Starts with `pr_`." + }, + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page to fetch. Starts from 1." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of sessions to retrieve." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataSessionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/sessions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "project_id": "project_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "id", + "projects": [ + { + "id": "id", + "name": "name", + "type": "prompt" + } + ], + "datapoints_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "reference_id": "reference_id", + "first_inputs": { + "key": "value" + }, + "last_output": "last_output" + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/sessions \\\n -H \"X-API-KEY: \" \\\n -d project_id=project_id", + "generated": true + } + ] + } + }, + { + "path": "/sessions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "project_id": "string", + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/sessions \\\n -H \"X-API-KEY: \" \\\n -d project_id=string \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ] + } + } + ] + }, + "endpoint_sessions.create": { + "id": "endpoint_sessions.create", + "namespace": [ + "subpackage_sessions" + ], + "description": "Create a new session.\n\nReturns a session ID that can be used to log datapoints to the session.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/sessions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateSessionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/sessions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/sessions \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/sessions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v4/sessions \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_sessions.get": { + "id": "endpoint_sessions.get", + "namespace": [ + "subpackage_sessions" + ], + "description": "Get a session by ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/sessions/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of session to return. Starts with `sesh_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SessionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/sessions/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "projects": [ + { + "id": "id", + "name": "name", + "type": "prompt" + } + ], + "datapoints_count": 1, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "reference_id": "reference_id", + "first_inputs": { + "key": "value" + }, + "last_output": "last_output" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/sessions/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/sessions/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/sessions/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects/activeConfig.get": { + "id": "endpoint_projects/activeConfig.get", + "namespace": [ + "subpackage_projects", + "subpackage_projects/activeConfig" + ], + "description": "Retrieves a config to use to execute your model.\n\nA config will be selected based on the project's\nactive config settings.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/active-config" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "queryParameters": [ + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name for the environment. E.g. 'production'. If not provided, will return the active config for the default environment." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetModelConfigResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id/active-config", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true, + "full_name": "full_name" + }, + "description": "config", + "other": { + "key": "value" + } + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "aggregate_value": 1.1 + } + ], + "environment_id": "environment_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/id/active-config \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id/active-config", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v4/projects/:id/active-config \\\n -H \"X-API-KEY: \" \\\n -d environment=string", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects/activeConfig.deactivate": { + "id": "endpoint_projects/activeConfig.deactivate", + "namespace": [ + "subpackage_projects", + "subpackage_projects/activeConfig" + ], + "description": "Remove the project's active config, if set.\n\nThis has no effect if the project does not have an active model config set.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/active-config" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "queryParameters": [ + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name for the environment. E.g. 'production'. If not provided, will delete the active config for the default environment." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ProjectResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id/active-config", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "users": [ + { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + } + ], + "data_count": 1, + "feedback_types": [ + { + "type": "rating", + "values": [ + { + "value": "value", + "sentiment": "positive" + } + ] + } + ], + "team_id": "team_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "active_config": { + "project_id": "project_id", + "project_name": "project_name", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "last_used": "2024-01-15T09:30:00Z", + "config": { + "type": "generic", + "id": "config", + "name": "config", + "status": "config", + "created_by": { + "id": "id", + "email_address": "email_address", + "verified": true + }, + "description": "config", + "other": { + "key": "value" + } + }, + "num_datapoints": 1, + "evaluation_aggregates": [ + { + "model_config_id": "model_config_id", + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id" + } + ] + }, + "config_type": "generic", + "active_evaluators": [ + { + "name": "name", + "description": "description", + "arguments_type": "target_free", + "return_type": "boolean", + "type": "python", + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "code": "code", + "model_config": { + "id": "id", + "model": "model" + } + } + ], + "directory_id": "directory_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/projects/id/active-config \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id/active-config", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://api.humanloop.com/v4/projects/:id/active-config?environment=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects/deployedConfig.list": { + "id": "endpoint_projects/deployedConfig.list", + "namespace": [ + "subpackage_projects", + "subpackage_projects/deployedConfig" + ], + "description": "Get an array of environments with the deployed configs associated to your project.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/deployed-configs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project. Starts with `pr_`." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentProjectConfigResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/id/deployed-configs", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "project_id": "project_id", + "project_name": "project_name", + "environment_id": "environment_id", + "environment_name": "environment_name", + "environment_tag": "environment_tag", + "model_config_id": "model_config_id", + "model_config_name": "model_config_name" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/id/deployed-configs \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:id/deployed-configs", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v4/projects/:id/deployed-configs \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects/deployedConfig.deploy": { + "id": "endpoint_projects/deployedConfig.deploy", + "namespace": [ + "subpackage_projects", + "subpackage_projects/deployedConfig" + ], + "description": "Deploy a model config to an environment.\n\nIf the environment already has a model config deployed, it will be replaced.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "project_id" + }, + { + "type": "literal", + "value": "/deploy-config" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Model config unique identifier generated by Humanloop." + }, + { + "key": "environments", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentRequest" + } + } + }, + "description": "List of environments to associate with the model config." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentProjectConfigResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/project_id/deploy-config", + "responseStatusCode": 200, + "pathParameters": { + "project_id": "project_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "config_id": "config_id" + } + }, + "responseBody": { + "type": "json", + "value": [ + { + "project_id": "project_id", + "project_name": "project_name", + "environment_id": "environment_id", + "environment_name": "environment_name", + "environment_tag": "environment_tag", + "model_config_id": "model_config_id", + "model_config_name": "model_config_name" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/projects/project_id/deploy-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"config_id\": \"config_id\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/projects/:project_id/deploy-config", + "responseStatusCode": 422, + "pathParameters": { + "project_id": ":project_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "config_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v4/projects/:project_id/deploy-config \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"config_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_projects/deployedConfig.delete": { + "id": "endpoint_projects/deployedConfig.delete", + "namespace": [ + "subpackage_projects", + "subpackage_projects/deployedConfig" + ], + "description": "Remove the version deployed to environment.\n\nThis has no effect if the project does not have an active version set.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/projects/" + }, + { + "type": "pathParameter", + "value": "project_id" + }, + { + "type": "literal", + "value": "/deployed-config/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v4" + } + ], + "pathParameters": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/projects/project_id/deployed-config/environment_id", + "responseStatusCode": 200, + "pathParameters": { + "project_id": "project_id", + "environment_id": "environment_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "key": "value" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/projects/project_id/deployed-config/environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/projects/:project_id/deployed-config/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "project_id": ":project_id", + "environment_id": ":environment_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v4/projects/:project_id/deployed-config/:environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_chats:ChatsCreateStreamRequestToolChoice": { + "name": "ChatsCreateStreamRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_chats:ChatsCreateStreamRequestToolCall": { + "name": "ChatsCreateStreamRequestToolCall", + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_chats:ChatsCreateRequestToolChoice": { + "name": "ChatsCreateRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_chats:ChatsCreateRequestToolCall": { + "name": "ChatsCreateRequestToolCall", + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_chats:ChatsCreateDeployedStreamRequestToolChoice": { + "name": "ChatsCreateDeployedStreamRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_chats:ChatsCreateDeployedStreamRequestToolCall": { + "name": "ChatsCreateDeployedStreamRequestToolCall", + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_chats:ChatsCreateDeployedRequestToolChoice": { + "name": "ChatsCreateDeployedRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_chats:ChatsCreateDeployedRequestToolCall": { + "name": "ChatsCreateDeployedRequestToolCall", + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_chats:ChatsCreateConfigStreamRequestToolChoice": { + "name": "ChatsCreateConfigStreamRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_chats:ChatsCreateConfigStreamRequestToolCall": { + "name": "ChatsCreateConfigStreamRequestToolCall", + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_chats:ChatsCreateConfigRequestToolChoice": { + "name": "ChatsCreateConfigRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_chats:ChatsCreateConfigRequestToolCall": { + "name": "ChatsCreateConfigRequestToolCall", + "description": "NB: Deprecated with new tool_choice. Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'name': } forces the model to use the provided tool of the same name.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_datasets:Request": { + "name": "Request", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Create Datapoints by Logs Request", + "shape": { + "type": "id", + "id": "type_:CreateDatapointsByLogsRequest" + } + }, + { + "displayName": "Create Datapoint Request", + "shape": { + "type": "id", + "id": "type_:CreateDatapointRequest" + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CreateDatapointRequest" + } + } + } + ] + } + }, + "type_evaluations:CreateEvaluationResultLogRequestResult": { + "name": "CreateEvaluationResultLogRequestResult", + "description": "The result value of the evaluation.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + ] + } + }, + "type_feedback:FeedbackFeedbackRequest": { + "name": "FeedbackFeedbackRequest", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FeedbackRequest" + } + } + }, + { + "displayName": "Feedback Request", + "shape": { + "type": "id", + "id": "type_:FeedbackRequest" + } + } + ] + } + }, + "type_feedback:FeedbackFeedbackResponse": { + "name": "FeedbackFeedbackResponse", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FeedbackResponse" + } + } + }, + { + "displayName": "Feedback Response", + "shape": { + "type": "id", + "id": "type_:FeedbackResponse" + } + } + ] + } + }, + "type_logs:LogsLogRequest": { + "name": "LogsLogRequest", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogRequest" + } + } + }, + { + "displayName": "Log Request", + "shape": { + "type": "id", + "id": "type_:LogRequest" + } + } + ] + } + }, + "type_logs:LogsLogResponse": { + "name": "LogsLogResponse", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CreateLogResponse" + } + } + }, + { + "displayName": "Create Log Response", + "shape": { + "type": "id", + "id": "type_:CreateLogResponse" + } + } + ] + } + }, + "type_modelConfigs:ProjectModelConfigRequestStop": { + "name": "ProjectModelConfigRequestStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_modelConfigs:ProjectModelConfigRequestToolsItem": { + "name": "ProjectModelConfigRequestToolsItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Linked Tool Request", + "shape": { + "type": "id", + "id": "type_:LinkedToolRequest" + } + }, + { + "displayName": "Model Config Tool Request", + "shape": { + "type": "id", + "id": "type_:ModelConfigToolRequest" + } + } + ] + } + }, + "type_modelConfigs:ModelConfigsSerializeRequest": { + "name": "ModelConfigsSerializeRequest", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Model Config Chat Request", + "shape": { + "type": "id", + "id": "type_:ModelConfigChatRequest" + } + }, + { + "displayName": "Model Config Completion Request", + "shape": { + "type": "id", + "id": "type_:ModelConfigCompletionRequest" + } + } + ] + } + }, + "type_:AgentConfigResponse": { + "name": "AgentConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of config. Starts with `config_`." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameters that define the config." + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the config." + }, + { + "key": "status", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Whether the config is committed or not." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of config." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description of config." + }, + { + "key": "agent_class", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Class of the agent." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolConfigRequest" + } + } + }, + "description": "Tools associated with the agent." + }, + { + "key": "model_config", + "valueShape": { + "type": "id", + "id": "type_:ModelConfigRequest" + }, + "description": "Model config associated with the agent." + } + ] + } + }, + "type_:CategoricalFeedbackLabel": { + "name": "CategoricalFeedbackLabel", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sentiment", + "valueShape": { + "type": "id", + "id": "type_:LabelSentiment" + }, + "description": "Whether the feedback sentiment is positive or negative." + } + ] + } + }, + "type_:ChatDataResponse": { + "name": "ChatDataResponse", + "description": "Overwrite DataResponse for chat.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID for the model inputs and output logged to Humanloop. Use this when recording feedback later." + }, + { + "key": "index", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index for the sampled generation for a given input. The num_samples request parameter controls how many samples are generated." + }, + { + "key": "output", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Output text returned from the provider model with leading and trailing whitespaces stripped." + }, + { + "key": "raw_output", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Raw output text returned from the provider model." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the chat template." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Why the generation ended. One of 'stop' (indicating a stop token was encountered), or 'length' (indicating the max tokens limit has been reached), or 'tool_call' (indicating that the model has chosen to call a tool - in which case the tool_call parameter of the response will be populated). It will be set as null for the intermediary responses during a stream, and will only be set as non-null for the final streamed token." + }, + { + "key": "model_config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model configuration used to create the generation." + }, + { + "key": "tool_results", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolResultResponse" + } + } + }, + "description": "Results of any tools run during the generation." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FunctionTool" + } + }, + "description": "Deprecated: Please use tool_calls field within the output_message.JSON definition of the tool to call and the corresponding argument values. Will be populated when finish_reason='tool_call'.", + "availability": "Deprecated" + }, + { + "key": "tool_calls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolCall" + } + } + }, + "description": "Deprecated: Please use tool_calls field within the output_message.JSON definition of the tools to call and the corresponding argument values. Will be populated when finish_reason='tool_call'." + }, + { + "key": "output_message", + "valueShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + }, + "description": "The message returned by the provider." + } + ] + } + }, + "type_:ChatMessageWithToolCallContentItem": { + "name": "ChatMessageWithToolCallContentItem", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "text", + "extends": [ + "type_:TextChatContent" + ], + "properties": [] + }, + { + "discriminantValue": "image_url", + "extends": [ + "type_:ImageChatContent" + ], + "properties": [] + } + ] + } + }, + "type_:Content": { + "name": "Content", + "description": "The content of the message.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCallContentItem" + } + } + } + ] + } + }, + "type_:ChatMessageWithToolCall": { + "name": "ChatMessageWithToolCall", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Content" + } + }, + "description": "The content of the message." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional name of the message author." + }, + { + "key": "tool_call_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Tool call that this message is responding to." + }, + { + "key": "role", + "valueShape": { + "type": "id", + "id": "type_:ChatRole" + }, + "description": "Role of the message author." + }, + { + "key": "tool_calls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolCall" + } + } + }, + "description": "A list of tool calls requested by the assistant." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FunctionTool" + } + }, + "description": "NB: Deprecated in favour of tool_calls. A tool call requested by the assistant.", + "availability": "Deprecated" + } + ] + } + }, + "type_:ChatResponseToolChoice": { + "name": "ChatResponseToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_:ChatResponse": { + "name": "ChatResponse", + "description": "Overwrite GenerateResponse for chat.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier of the parent project. Will not be provided if the request was made without providing a project name or id" + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of chat responses." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "data", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatDataResponse" + } + }, + "description": "Array containing the chat responses." + }, + { + "key": "usage", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Usage" + } + }, + "description": "Counts of the number of tokens used and related stats." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "provider_responses", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + }, + "description": "The raw responses returned by the model provider." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The raw request sent to the model provider." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session if it belongs to one." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatResponseToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + } + ] + } + }, + "type_:ChatRole": { + "name": "ChatRole", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + }, + { + "value": "system" + }, + { + "value": "tool" + } + ] + } + }, + "type_:CompletionResponse": { + "name": "CompletionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier of the parent project. Will not be provided if the request was made without providing a project name or id" + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "How many completions to make for each set of inputs." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID passed through to provider call." + }, + { + "key": "data", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DataResponse" + } + }, + "description": "Array containing the generation responses." + }, + { + "key": "usage", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Usage" + } + }, + "description": "Counts of the number of tokens used and related stats." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "provider_responses", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + }, + "description": "The raw responses returned by the model provider." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The raw request sent to the model provider." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session if it belongs to one." + } + ] + } + }, + "type_:ConfigResponse": { + "name": "ConfigResponse", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "model", + "extends": [ + "type_:ModelConfigResponse" + ], + "properties": [] + }, + { + "discriminantValue": "tool", + "extends": [ + "type_:ToolConfigResponse" + ], + "properties": [] + }, + { + "discriminantValue": "evaluator", + "extends": [ + "type_:EvaluatorConfigResponse" + ], + "properties": [] + }, + { + "discriminantValue": "agent", + "extends": [ + "type_:AgentConfigResponse" + ], + "properties": [] + }, + { + "discriminantValue": "generic", + "extends": [ + "type_:GenericConfigResponse" + ], + "properties": [] + } + ] + } + }, + "type_:ConfigType": { + "name": "ConfigType", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "generic" + }, + { + "value": "model" + }, + { + "value": "tool" + }, + { + "value": "agent" + }, + { + "value": "evaluator" + } + ] + } + }, + "type_:CreateDatapointRequestTargetValue": { + "name": "CreateDatapointRequestTargetValue", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:CreateDatapointRequest": { + "name": "CreateDatapointRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The inputs to the prompt template for this datapoint." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "The chat messages for this datapoint." + }, + { + "key": "target", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:CreateDatapointRequestTargetValue" + } + } + }, + "description": "Object with criteria necessary to evaluate this datapoint." + } + ] + } + }, + "type_:CreateDatapointsByLogsRequest": { + "name": "CreateDatapointsByLogsRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "log_ids", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The IDs of the logs to create datapoints from." + } + ] + } + }, + "type_:CreateLogResponse": { + "name": "CreateLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of logged datapoint. Starts with `data_`." + }, + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project the datapoint belongs to. Starts with `pr_`." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of session the datapoint belongs to. Populated only if the datapoint was logged with `session_id` or `session_reference_id`, and is `None` otherwise. Starts with `sesh_`." + } + ] + } + }, + "type_:CreateSessionResponse": { + "name": "CreateSessionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of session. Starts with `sesh_`." + } + ] + } + }, + "type_:DashboardConfiguration": { + "name": "DashboardConfiguration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "time_unit", + "valueShape": { + "type": "id", + "id": "type_:TimeUnit" + } + }, + { + "key": "time_range_days", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "model_config_ids", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:DataResponse": { + "name": "DataResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID for the model inputs and output logged to Humanloop. Use this when recording feedback later." + }, + { + "key": "index", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index for the sampled generation for a given input. The num_samples request parameter controls how many samples are generated." + }, + { + "key": "output", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Output text returned from the provider model with leading and trailing whitespaces stripped." + }, + { + "key": "raw_output", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Raw output text returned from the provider model." + }, + { + "key": "inputs", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Why the generation ended. One of 'stop' (indicating a stop token was encountered), or 'length' (indicating the max tokens limit has been reached), or 'tool_call' (indicating that the model has chosen to call a tool - in which case the tool_call parameter of the response will be populated). It will be set as null for the intermediary responses during a stream, and will only be set as non-null for the final streamed token." + }, + { + "key": "model_config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model configuration used to create the generation." + }, + { + "key": "tool_results", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolResultResponse" + } + } + }, + "description": "Results of any tools run during the generation." + } + ] + } + }, + "type_:DatapointResponseTargetValue": { + "name": "DatapointResponseTargetValue", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:DatapointResponse": { + "name": "DatapointResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "dataset_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:DatapointResponseTargetValue" + } + } + } + } + ] + } + }, + "type_:DatasetResponse": { + "name": "DatasetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Datasets are now files and do not belong to projects. If this dataset was created before that change, the legacy project ID will be provided here, otherwise an empty string will be returned.", + "availability": "Deprecated" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "datapoint_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + ] + } + }, + "type_:EnvironmentProjectConfigResponse": { + "name": "EnvironmentProjectConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project the model config belongs to. Starts with `pr_`." + }, + { + "key": "project_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the project the model config belongs to." + }, + { + "key": "model_config_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model config unique identifier generated by Humanloop." + }, + { + "key": "model_config_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly display name for the model config." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the environment." + }, + { + "key": "environment_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the environment." + }, + { + "key": "environment_tag", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Tag for the environment e.g. 'default' or 'other'." + } + ] + } + }, + "type_:EnvironmentRequest": { + "name": "EnvironmentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of the environment. Starts with `env_`." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment name." + } + ] + } + }, + "type_:EvaluationDatapointSnapshotResponse": { + "name": "EvaluationDatapointSnapshotResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "datapoint", + "valueShape": { + "type": "id", + "id": "type_:DatapointResponse" + } + }, + { + "key": "log", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + { + "key": "evaluation_results", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationResultResponse" + } + } + } + ] + } + }, + "type_:EvaluationResponse": { + "name": "EvaluationResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID for the evaluation. Starts with `ev_`." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:EvaluationStatus" + } + }, + { + "key": "config", + "valueShape": { + "type": "id", + "id": "type_:ConfigResponse" + } + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "evaluators", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + { + "key": "dataset", + "valueShape": { + "type": "id", + "id": "type_:DatasetResponse" + } + }, + { + "key": "dataset_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "dataset_snapshot", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelConfigEvaluatorAggregateResponse" + } + } + } + } + ] + } + }, + "type_:Value": { + "name": "Value", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:EvaluationResultResponse": { + "name": "EvaluationResultResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "evaluator_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "evaluation_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "log_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "log", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Value" + } + } + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "evaluator_log", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LogResponse" + } + } + } + ] + } + }, + "type_:EvaluationStatus": { + "name": "EvaluationStatus", + "description": "Status of an evaluation.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "running" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + } + ] + } + }, + "type_:EvaluatorArgumentsType": { + "name": "EvaluatorArgumentsType", + "description": "Enum representing the possible argument types of an evaluator.", + "shape": { + "type": "enum", + "values": [ + { + "value": "target_free" + }, + { + "value": "target_required" + } + ] + } + }, + "type_:EvaluatorConfigResponse": { + "name": "EvaluatorConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of config. Starts with `config_`." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameters that define the config." + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the config." + }, + { + "key": "status", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Whether the config is committed or not." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of config." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description of config." + }, + { + "key": "evaluator_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Type of evaluator." + }, + { + "key": "model_config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigResponse" + } + }, + "description": "The model config defining the LLM evaluator." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The code for the evaluator. This code will be executed in a sandboxed environment." + }, + { + "key": "arguments_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + } + }, + "description": "Whether this evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluatorReturnTypeEnum" + } + }, + "description": "The type of the return value of the evaluator." + } + ] + } + }, + "type_:EvaluatorResponse": { + "name": "EvaluatorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1 + } + }, + "description": "The name of the evaluator." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The description of the evaluator." + }, + { + "key": "arguments_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + }, + "description": "Whether this evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorReturnTypeEnum" + }, + "description": "The type of the return value of the evaluator." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The code for the evaluator. This code will be executed in a sandboxed environment." + }, + { + "key": "model_config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigResponse" + } + }, + "description": "The model config defining the LLM evaluator." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorType" + }, + "description": "The type of the evaluator." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID for the evaluator. Starts with `evfn_`." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "logging_project", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectResponse" + } + }, + "description": "The project where the evaluator logs are stored." + } + ] + } + }, + "type_:EvaluatorReturnTypeEnum": { + "name": "EvaluatorReturnTypeEnum", + "description": "Enum representing the possible return types of an evaluator.", + "shape": { + "type": "enum", + "values": [ + { + "value": "boolean" + }, + { + "value": "number" + }, + { + "value": "select" + }, + { + "value": "multi_select" + }, + { + "value": "text" + } + ] + } + }, + "type_:EvaluatorType": { + "name": "EvaluatorType", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "python" + }, + { + "value": "llm" + }, + { + "value": "human" + }, + { + "value": "external" + } + ] + } + }, + "type_:FeedbackType": { + "name": "FeedbackType", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "rating" + }, + { + "value": "action" + }, + { + "value": "issue" + }, + { + "value": "correction" + }, + { + "value": "comment" + } + ] + } + }, + "type_:FeedbackValue": { + "name": "FeedbackValue", + "description": "The feedback value to set. This would be the appropriate text for 'correction' or 'comment', or a label to apply for 'rating', 'action', or 'issue'.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:Feedback": { + "name": "Feedback", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:FeedbackType" + }, + "description": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'." + }, + { + "key": "value", + "valueShape": { + "type": "id", + "id": "type_:FeedbackValue" + }, + "description": "The feedback value to set. This would be the appropriate text for 'correction' or 'comment', or a label to apply for 'rating', 'action', or 'issue'." + }, + { + "key": "data_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID to associate the feedback to a previously logged datapoint." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier to who provided the feedback." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the feedback was created." + } + ] + } + }, + "type_:FeedbackClass": { + "name": "FeedbackClass", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "select" + }, + { + "value": "multi_select" + }, + { + "value": "text" + }, + { + "value": "number" + } + ] + } + }, + "type_:FeedbackLabelRequest": { + "name": "FeedbackLabelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sentiment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LabelSentiment" + } + } + } + ] + } + }, + "type_:FeedbackRequestType": { + "name": "FeedbackRequestType", + "description": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Feedback Type", + "shape": { + "type": "id", + "id": "type_:FeedbackType" + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:FeedbackRequestValue": { + "name": "FeedbackRequestValue", + "description": "The feedback value to be set. This field should be left blank when unsetting 'rating', 'correction' or 'comment', but is required otherwise.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:FeedbackRequest": { + "name": "FeedbackRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:FeedbackRequestType" + }, + "description": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'." + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FeedbackRequestValue" + } + }, + "description": "The feedback value to be set. This field should be left blank when unsetting 'rating', 'correction' or 'comment', but is required otherwise." + }, + { + "key": "data_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID to associate the feedback to a previously logged datapoint." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier to who provided the feedback." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the feedback was created." + }, + { + "key": "unset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, the value for this feedback is unset." + } + ] + } + }, + "type_:FeedbackResponseType": { + "name": "FeedbackResponseType", + "description": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Feedback Type", + "shape": { + "type": "id", + "id": "type_:FeedbackType" + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:FeedbackResponseValue": { + "name": "FeedbackResponseValue", + "description": "The feedback value to set. This would be the appropriate text for 'correction' or 'comment', or a label to apply for 'rating', 'action', or 'issue'.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:FeedbackResponse": { + "name": "FeedbackResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:FeedbackResponseType" + }, + "description": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'." + }, + { + "key": "value", + "valueShape": { + "type": "id", + "id": "type_:FeedbackResponseValue" + }, + "description": "The feedback value to set. This would be the appropriate text for 'correction' or 'comment', or a label to apply for 'rating', 'action', or 'issue'." + }, + { + "key": "data_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID to associate the feedback to a previously logged datapoint." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier to who provided the feedback." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the feedback was created." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of user feedback. Starts with `ann_`, short for annotation." + } + ] + } + }, + "type_:FeedbackTypeModelType": { + "name": "FeedbackTypeModelType", + "description": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Feedback Type", + "shape": { + "type": "id", + "id": "type_:FeedbackType" + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:FeedbackTypeModel": { + "name": "FeedbackTypeModel", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:FeedbackTypeModelType" + }, + "description": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'." + }, + { + "key": "values", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CategoricalFeedbackLabel" + } + } + }, + "description": "The allowed values for categorical feedback types. Not populated for `correction` and `comment`." + } + ] + } + }, + "type_:FeedbackTypes": { + "name": "FeedbackTypes", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FeedbackTypeModel" + } + } + } + }, + "type_:FileType": { + "name": "FileType", + "description": "Enum for File types.", + "shape": { + "type": "enum", + "values": [ + { + "value": "prompt" + }, + { + "value": "tool" + }, + { + "value": "dataset" + }, + { + "value": "evaluator" + }, + { + "value": "flow" + } + ] + } + }, + "type_:FunctionTool": { + "name": "FunctionTool", + "description": "A function tool to be called by the model where user owns runtime.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "arguments", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:FunctionToolChoice": { + "name": "FunctionToolChoice", + "description": "A function tool to be called by the model where user owns runtime.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:GenericConfigResponse": { + "name": "GenericConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of config. Starts with `config_`." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameters that define the config." + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the config." + }, + { + "key": "status", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Whether the config is committed or not." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of config." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description of config." + } + ] + } + }, + "type_:GetModelConfigResponse": { + "name": "GetModelConfigResponse", + "description": "A selected model configuration.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project the model config belongs to. Starts with `pr_`." + }, + { + "key": "project_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the project the model config belongs to." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "last_used", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "num_datapoints", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of datapoints associated with this project model config." + }, + { + "key": "evaluation_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelConfigEvaluatorAggregateResponse" + } + } + }, + "description": "Aggregates of evaluators for the model config." + }, + { + "key": "config", + "valueShape": { + "type": "id", + "id": "type_:ConfigResponse" + } + }, + { + "key": "environment_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of environment to reference in subsequent log calls." + } + ] + } + }, + "type_:HTTPValidationError": { + "name": "HTTPValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ValidationError" + } + } + } + } + ] + } + }, + "type_:ImageChatContent": { + "name": "ImageChatContent", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "image_url", + "valueShape": { + "type": "id", + "id": "type_:ImageUrl" + }, + "description": "The message's image content." + } + ] + } + }, + "type_:ImageUrlDetail": { + "name": "ImageUrlDetail", + "description": "Specify the detail level of the image provided to the model. For more details see: https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding", + "shape": { + "type": "enum", + "values": [ + { + "value": "high" + }, + { + "value": "low" + }, + { + "value": "auto" + } + ] + } + }, + "type_:ImageUrl": { + "name": "ImageUrl", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Either a URL of the image or the base64 encoded image data." + }, + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageUrlDetail" + } + }, + "description": "Specify the detail level of the image provided to the model. For more details see: https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding" + } + ] + } + }, + "type_:LabelSentiment": { + "name": "LabelSentiment", + "description": "How a label should be treated in calculating Version performance.\n\nUsed by a File's PAPV (Positive Action Per View) metric.", + "shape": { + "type": "enum", + "values": [ + { + "value": "positive" + }, + { + "value": "negative" + }, + { + "value": "neutral" + }, + { + "value": "unset" + } + ] + } + }, + "type_:LinkedToolRequest": { + "name": "LinkedToolRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the linked tool. Starts with \"oc\\_\"" + }, + { + "key": "source", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "organization" + } + }, + "description": "The source of the linked tool. For a linked tool it should be `organization`" + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the linked tool." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the linked tool." + }, + { + "key": "strict", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the tool is strict or not. If strict, the model will be forced to respond with JSON matching the parameters schema." + }, + { + "key": "parameters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The parameters of the linked tool." + } + ] + } + }, + "type_:Judgment": { + "name": "Judgment", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:Config": { + "name": "Config", + "description": "The model config used for this generation. Required unless `config_id` is provided.", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "model", + "extends": [ + "type_:ModelConfigRequest" + ], + "properties": [] + }, + { + "discriminantValue": "tool", + "extends": [ + "type_:ToolConfigRequest" + ], + "properties": [] + } + ] + } + }, + "type_:LogRequestFeedback": { + "name": "LogRequestFeedback", + "description": "Optional parameter to provide feedback with your logged datapoint.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Feedback", + "shape": { + "type": "id", + "id": "type_:Feedback" + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Feedback" + } + } + } + ] + } + }, + "type_:LogRequest": { + "name": "LogRequest", + "description": "Request model for logging a datapoint.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique project name. If no project exists with this name, a new project will be created." + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a project to associate to the log. Either this or `project` must be provided." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string to reference the datapoint. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a subsequent log request." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if logging a parent datapoint with the intention to populate it later" + }, + { + "key": "judgment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Judgment" + } + } + }, + { + "key": "config_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a config to associate to the log." + }, + { + "key": "config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Config" + } + }, + "description": "The model config used for this generation. Required unless `config_id` is provided." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment name used to create the log." + }, + { + "key": "feedback", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LogRequestFeedback" + } + }, + "description": "Optional parameter to provide feedback with your logged datapoint." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "duration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "output_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The message returned by the provider." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the prompt used to generate the output." + }, + { + "key": "output_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the output generated by the model." + }, + { + "key": "prompt_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the prompt." + }, + { + "key": "output_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the output." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + } + ] + } + }, + "type_:LogResponseToolChoice": { + "name": "LogResponseToolChoice", + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_:LogResponse": { + "name": "LogResponse", + "description": "Request model for logging a datapoint.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the project associated with this log" + }, + { + "key": "project_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique ID of the project associated with this log." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the session to associate the datapoint." + }, + { + "key": "session_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same `session_reference_id` in subsequent log requests. Specify at most one of this or `session_id`." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID associated to the parent datapoint in a session." + }, + { + "key": "parent_reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as `parent_id` in a prior log request. Specify at most one of this or `parent_id`. Note that this cannot refer to a datapoint being logged in the same request." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the source datapoint if this is a log derived from a datapoint in a dataset." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of logged datapoint. Starts with `data_`." + }, + { + "key": "reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique user-provided string identifying the datapoint." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if logging a parent datapoint with the intention to populate it later" + }, + { + "key": "judgment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Judgment" + } + } + }, + { + "key": "config_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique ID of a config to associate to the log." + }, + { + "key": "config", + "valueShape": { + "type": "id", + "id": "type_:ConfigResponse" + } + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The environment name used to create the log." + }, + { + "key": "feedback", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FeedbackResponse" + } + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "duration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "output_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + }, + "description": "The message returned by the provider." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the prompt used to generate the output." + }, + { + "key": "output_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the output generated by the model." + }, + { + "key": "prompt_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the prompt." + }, + { + "key": "output_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the output." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "User email address provided when creating the datapoint." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Latency of provider response." + }, + { + "key": "tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Total number of tokens in the prompt and output." + }, + { + "key": "raw_output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Raw output from the provider." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Reason the generation finished." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolResultResponse" + } + } + } + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LogResponseToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function." + }, + { + "key": "evaluation_results", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationResultResponse" + } + } + }, + { + "key": "observability_status", + "valueShape": { + "type": "id", + "id": "type_:ObservabilityStatus" + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "batch_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "List of batch IDs the log belongs to." + } + ] + } + }, + "type_:ModelConfigChatRequestStop": { + "name": "ModelConfigChatRequestStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ModelConfigChatRequestToolsItem": { + "name": "ModelConfigChatRequestToolsItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Linked Tool Request", + "shape": { + "type": "id", + "id": "type_:LinkedToolRequest" + } + }, + { + "displayName": "Model Config Tool Request", + "shape": { + "type": "id", + "id": "type_:ModelConfigToolRequest" + } + } + ] + } + }, + "type_:ModelConfigChatRequest": { + "name": "ModelConfigChatRequest", + "description": "Chat model config request.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly display name for the model config. If not provided, a name will be generated." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the model config." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used. E.g. text-davinci-002." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigChatRequestStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "The provider model endpoint used." + }, + { + "key": "chat_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. Input variables within the template should be specified with syntax: {{INPUT_NAME}}." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelConfigChatRequestToolsItem" + } + } + }, + "description": "Make tools available to OpenAIs chat model as functions." + } + ] + } + }, + "type_:ModelConfigCompletionRequestStop": { + "name": "ModelConfigCompletionRequestStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ModelConfigCompletionRequest": { + "name": "ModelConfigCompletionRequest", + "description": "Completion model config request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly display name for the model config. If not provided, a name will be generated." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the model config." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used. E.g. text-davinci-002." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigCompletionRequestStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "The provider model endpoint used." + }, + { + "key": "prompt_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Prompt template that will take your specified inputs to form your final request to the model. Input variables within the prompt template should be specified with syntax: {{INPUT_NAME}}." + } + ] + } + }, + "type_:ModelConfigEvaluatorAggregateResponse": { + "name": "ModelConfigEvaluatorAggregateResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "model_config_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "evaluator_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "aggregate_value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "type_:ModelConfigRequestStop": { + "name": "ModelConfigRequestStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ModelConfigRequestToolsItem": { + "name": "ModelConfigRequestToolsItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Linked Tool Request", + "shape": { + "type": "id", + "id": "type_:LinkedToolRequest" + } + }, + { + "displayName": "Model Config Tool Request", + "shape": { + "type": "id", + "id": "type_:ModelConfigToolRequest" + } + } + ] + } + }, + "type_:ModelConfigRequest": { + "name": "ModelConfigRequest", + "description": "Model config used for logging both chat and completion.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly display name for the model config. If not provided, a name will be generated." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the model config." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used. E.g. text-davinci-002." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigRequestStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "The provider model endpoint used." + }, + { + "key": "prompt_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Prompt template that will take your specified inputs to form your final request to the model. Input variables within the prompt template should be specified with syntax: {{INPUT_NAME}}." + }, + { + "key": "chat_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. Input variables within the template should be specified with syntax: {{INPUT_NAME}}." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelConfigRequestToolsItem" + } + } + }, + "description": "Make tools available to OpenAIs chat model as functions." + } + ] + } + }, + "type_:ModelConfigResponseStop": { + "name": "ModelConfigResponseStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ModelConfigResponse": { + "name": "ModelConfigResponse", + "description": "Model config request.\n\nContains fields that are common to all (i.e. both chat and complete) endpoints.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of config. Starts with `config_`." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly display name for the model config. If not provided, a name will be generated." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the model config." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used. E.g. text-davinci-002." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelConfigResponseStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only type json_object is currently supported for chat." + }, + { + "key": "prompt_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Prompt template that will take your specified inputs to form your final request to the model. NB: Input variables within the prompt template should be specified with syntax: {{INPUT_NAME}}." + }, + { + "key": "chat_template", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageWithToolCall" + } + } + }, + "description": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. NB: Input variables within the template should be specified with syntax: {{INPUT_NAME}}." + }, + { + "key": "tool_configs", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolConfigResponse" + } + } + }, + "description": "NB: Deprecated with tools field. Definition of tools shown to the model.", + "availability": "Deprecated" + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + "description": "Tools shown to the model." + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "The provider model endpoint used." + } + ] + } + }, + "type_:ModelConfigToolRequest": { + "name": "ModelConfigToolRequest", + "description": "Definition of tool within a model config.\n\nThe subset of ToolConfig parameters received by the chat endpoint.\nDoes not have things like the signature or setup schema.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the tool shown to the model." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the tool shown to the model." + }, + { + "key": "strict", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the tool is strict or not. If strict, the model will be forced to respond with JSON matching the parameters schema." + }, + { + "key": "parameters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Definition of parameters needed to run the tool. Provided in jsonschema format: https://json-schema.org/" + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolSource" + } + }, + "description": "Source of the tool. If defined at an organization level will be 'organization' else 'inline'." + }, + { + "key": "source_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code source of the tool." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameters that define the config." + }, + { + "key": "preset_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If is_preset = true, this is the name of the preset tool on Humanloop. This is used as the key to look up the Humanloop runtime of the tool" + } + ] + } + }, + "type_:ModelEndpoints": { + "name": "ModelEndpoints", + "description": "Supported model provider endpoints.", + "shape": { + "type": "enum", + "values": [ + { + "value": "complete" + }, + { + "value": "chat" + }, + { + "value": "edit" + } + ] + } + }, + "type_:ModelProviders": { + "name": "ModelProviders", + "description": "Supported model providers.", + "shape": { + "type": "enum", + "values": [ + { + "value": "openai" + }, + { + "value": "openai_azure" + }, + { + "value": "mock" + }, + { + "value": "anthropic" + }, + { + "value": "bedrock" + }, + { + "value": "cohere" + }, + { + "value": "replicate" + }, + { + "value": "google" + }, + { + "value": "groq" + } + ] + } + }, + "type_:ObservabilityStatus": { + "name": "ObservabilityStatus", + "description": "Status of a Log for observability.\n\nObservability is implemented by running monitoring Evaluators on Logs.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "running" + }, + { + "value": "completed" + }, + { + "value": "failed" + } + ] + } + }, + "type_:PaginatedDataDatapointResponse": { + "name": "PaginatedDataDatapointResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatapointResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataEvaluationDatapointSnapshotResponse": { + "name": "PaginatedDataEvaluationDatapointSnapshotResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationDatapointSnapshotResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataEvaluationResponse": { + "name": "PaginatedDataEvaluationResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataLogResponse": { + "name": "PaginatedDataLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataProjectResponse": { + "name": "PaginatedDataProjectResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProjectResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataSessionResponse": { + "name": "PaginatedDataSessionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SessionResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PlatformAccessEnum": { + "name": "PlatformAccessEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "superadmin" + }, + { + "value": "supportadmin" + }, + { + "value": "user" + } + ] + } + }, + "type_:ProjectConfigResponse": { + "name": "ProjectConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "project_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project the model config belongs to. Starts with `pr_`." + }, + { + "key": "project_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the project the model config belongs to." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "last_used", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "num_datapoints", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of datapoints associated with this project model config." + }, + { + "key": "evaluation_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelConfigEvaluatorAggregateResponse" + } + } + }, + "description": "Aggregates of evaluators for the model config." + }, + { + "key": "config", + "valueShape": { + "type": "id", + "id": "type_:ConfigResponse" + } + } + ] + } + }, + "type_:ProjectInputResponse": { + "name": "ProjectInputResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Type of input." + } + ] + } + }, + "type_:ProjectResponse": { + "name": "ProjectResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Project ID" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique project name." + }, + { + "key": "active_config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectConfigResponse" + } + }, + "description": "Config that has been set as the project's active deployment." + }, + { + "key": "users", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProjectUserResponse" + } + }, + "description": "Users associated to the project." + }, + { + "key": "data_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The count of datapoints that have been logged to the project." + }, + { + "key": "feedback_types", + "valueShape": { + "type": "id", + "id": "type_:FeedbackTypes" + }, + "description": "The feedback types that have been defined in the project." + }, + { + "key": "team_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID of the team the project belongs to. Starts with `tm_`." + }, + { + "key": "config_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConfigType" + } + } + }, + { + "key": "active_evaluators", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "description": "Evaluators that have been set as active for the project." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of the directory the project belongs to. Starts with `dir_`." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + ] + } + }, + "type_:ProjectSortBy": { + "name": "ProjectSortBy", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "created_at" + }, + { + "value": "updated_at" + }, + { + "value": "name" + } + ] + } + }, + "type_:ProjectUserResponse": { + "name": "ProjectUserResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of user. Starts with `usr_`." + }, + { + "key": "email_address", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The user's email address." + }, + { + "key": "full_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user's full name." + } + ] + } + }, + "type_:ProviderApiKeys": { + "name": "ProviderApiKeys", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "openai", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "ai21", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mock", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "anthropic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "bedrock", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "cohere", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "openai_azure", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "openai_azure_endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Type": { + "name": "Type", + "shape": { + "type": "enum", + "values": [ + { + "value": "json_object" + }, + { + "value": "json_schema" + } + ] + } + }, + "type_:ResponseFormat": { + "name": "ResponseFormat", + "description": "Response format of the model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:Type" + } + }, + { + "key": "json_schema", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The JSON schema of the response format if type is json_schema." + } + ] + } + }, + "type_:SessionProjectResponse": { + "name": "SessionProjectResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of project the datapoint belongs to. Starts with `pr_`." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:FileType" + }, + "description": "Type of project. e.g. `prompt` or `tool`." + } + ] + } + }, + "type_:SessionResponse": { + "name": "SessionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of session. Starts with `sesh_`." + }, + { + "key": "reference_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique user-provided string identifying the session." + }, + { + "key": "projects", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SessionProjectResponse" + } + }, + "description": "List of projects that have datapoints associated to this session." + }, + { + "key": "datapoints_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of datapoints associated to this session." + }, + { + "key": "first_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Inputs for the first datapoint in the session." + }, + { + "key": "last_output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Output for the last datapoint in the session." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + ] + } + }, + "type_:SortOrder": { + "name": "SortOrder", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + }, + "type_:TextChatContent": { + "name": "TextChatContent", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The message's text content." + } + ] + } + }, + "type_:TimeUnit": { + "name": "TimeUnit", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "day" + }, + { + "value": "week" + }, + { + "value": "month" + } + ] + } + }, + "type_:ToolCall": { + "name": "ToolCall", + "description": "A tool call to be made.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ToolType" + } + }, + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:FunctionTool" + } + } + ] + } + }, + "type_:ToolChoice": { + "name": "ToolChoice", + "description": "Tool choice to force the model to use a tool.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ToolType" + } + }, + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:FunctionToolChoice" + } + } + ] + } + }, + "type_:ToolConfigRequest": { + "name": "ToolConfigRequest", + "description": "Definition of tool within a model config.\n\nThe subset of ToolConfig parameters received by the chat endpoint.\nDoes not have things like the signature or setup schema.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the tool shown to the model." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the tool shown to the model." + }, + { + "key": "strict", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the tool is strict or not. If strict, the model will be forced to respond with JSON matching the parameters schema." + }, + { + "key": "parameters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Definition of parameters needed to run the tool. Provided in jsonschema format: https://json-schema.org/" + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolSource" + } + }, + "description": "Source of the tool. If defined at an organization level will be 'organization' else 'inline'." + }, + { + "key": "source_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code source of the tool." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameters that define the config." + }, + { + "key": "preset_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If is_preset = true, this is the name of the preset tool on Humanloop. This is used as the key to look up the Humanloop runtime of the tool" + } + ] + } + }, + "type_:ToolConfigResponse": { + "name": "ToolConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of config. Starts with `config_`." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameters that define the config." + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the config." + }, + { + "key": "status", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Whether the config is committed or not." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name for the tool referenced by the model." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description of the tool referenced by the model" + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolSource" + } + }, + "description": "Source of the tool. If defined at an organization level will be 'organization' else 'inline'." + }, + { + "key": "source_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code source of the tool." + }, + { + "key": "setup_schema", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Definition of parameters needed to run the tool. Provided in jsonschema format: https://json-schema.org/" + }, + { + "key": "parameters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Definition of parameters needed to run the tool. Provided in jsonschema format: https://json-schema.org/" + }, + { + "key": "signature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The function signature of the tool when being called." + }, + { + "key": "is_preset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the tool is one where Humanloop defines runtime or not." + }, + { + "key": "preset_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If is_preset = true, this is the name of the preset tool on Humanloop. This is used as the key to lookup the Humanloop runtime of the tool" + } + ] + } + }, + "type_:ToolResponse": { + "name": "ToolResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the tool. Starts with either `config_` or `oc_`." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name for the tool referenced by the model." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description of the tool referenced by the model" + }, + { + "key": "parameters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Definition of parameters needed to run the tool. Provided in jsonschema format: https://json-schema.org/" + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The origin of the tool" + } + ] + } + }, + "type_:ToolResultResponse": { + "name": "ToolResultResponse", + "description": "A result from a tool used to populate the prompt template", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "signature", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "result", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ToolSource": { + "name": "ToolSource", + "description": "Source of tool. Used to differentiate between tools and tool versions when they are combined in a list.\n\nV4 uses organization and inline. Those are deprecated and will be removed in favour of tool and tool_version.", + "shape": { + "type": "enum", + "values": [ + { + "value": "organization" + }, + { + "value": "inline" + } + ] + } + }, + "type_:ToolType": { + "name": "ToolType", + "description": "The type of tool to call.", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "function" + } + } + } + }, + "type_:UpdateLogRequest": { + "name": "UpdateLogRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "duration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + } + ] + } + }, + "type_:Usage": { + "name": "Usage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "prompt_tokens", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of tokens used in the prompt." + }, + { + "key": "generation_tokens", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of tokens produced by the generation." + }, + { + "key": "total_tokens", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Total number of tokens used by the prompt and generation combined." + } + ] + } + }, + "type_:UserResponse": { + "name": "UserResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of user. Starts with `usr_`." + }, + { + "key": "email_address", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The user's email address." + }, + { + "key": "full_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user's full name." + }, + { + "key": "verified", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the user has verified their email address." + } + ] + } + }, + "type_:ValidationErrorLocItem": { + "name": "ValidationErrorLocItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:ValidationError": { + "name": "ValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "loc", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ValidationErrorLocItem" + } + } + }, + { + "key": "msg", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:VersionStatus": { + "name": "VersionStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "uncommitted" + }, + { + "value": "committed" + }, + { + "value": "deleted" + } + ] + } + } + }, + "subpackages": { + "subpackage_chats": { + "id": "subpackage_chats", + "name": "chats" + }, + "subpackage_completions": { + "id": "subpackage_completions", + "name": "completions" + }, + "subpackage_datapoints": { + "id": "subpackage_datapoints", + "name": "datapoints" + }, + "subpackage_projects": { + "id": "subpackage_projects", + "name": "projects" + }, + "subpackage_datasets": { + "id": "subpackage_datasets", + "name": "datasets" + }, + "subpackage_evaluations": { + "id": "subpackage_evaluations", + "name": "evaluations" + }, + "subpackage_evaluators": { + "id": "subpackage_evaluators", + "name": "evaluators" + }, + "subpackage_feedback": { + "id": "subpackage_feedback", + "name": "feedback" + }, + "subpackage_logs": { + "id": "subpackage_logs", + "name": "logs" + }, + "subpackage_modelConfigs": { + "id": "subpackage_modelConfigs", + "name": "modelConfigs" + }, + "subpackage_sessions": { + "id": "subpackage_sessions", + "name": "sessions" + }, + "subpackage_projects/activeConfig": { + "id": "subpackage_projects/activeConfig", + "name": "activeConfig" + }, + "subpackage_projects/deployedConfig": { + "id": "subpackage_projects/deployedConfig", + "name": "deployedConfig" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-API-KEY", + "nameOverride": "apiKey" + } + } + }, + { + "id": "d8feb9f1-c5b3-4935-9375-ad1f1826d72d", + "endpoints": { + "endpoint_prompts.log": { + "id": "endpoint_prompts.log", + "namespace": [ + "subpackage_prompts" + ], + "description": "Log to a Prompt.\n\nYou can use query parameters `version_id`, or `environment`, to target\nan existing version of the Prompt. Otherwise, the default deployed version will be chosen.\n\nInstead of targeting an existing version explicitly, you can instead pass in\nPrompt details in the request body. In this case, we will check if the details correspond\nto an existing version of the Prompt. If they do not, we will create a new version. This is helpful\nin the case where you are storing or deriving your Prompt details in code.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/prompts/log" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Prompt to log to." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed version to log to." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluation_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Evaluation Report to associate the Log to." + }, + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Prompt." + }, + { + "key": "output_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessage" + } + }, + "description": "The message returned by the provider." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the prompt used to generate the output." + }, + { + "key": "output_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the output generated by the model." + }, + { + "key": "prompt_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the prompt." + }, + { + "key": "output_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the output." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Reason the generation finished." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_prompts:PromptLogRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: \n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. \n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. \n- `'required'` means the model can decide to call one or more of the provided tools. \n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function." + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptKernelRequest" + } + }, + "description": "Details of your Prompt. A new Prompt version will be created if the provided details are new." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created. " + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreatePromptLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/log", + "responseStatusCode": 200, + "name": "Log prompt", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "path": "persona", + "output_message": { + "role": "assistant", + "content": "Well, you know, there is so much secrecy involved in government, folks, it's unbelievable. They don't want to tell you everything. They don't tell me everything! But about Roswell, it’s a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I'd love to go down and open up all the classified documents, believe me, I would. But they don't let that happen. The Deep State, folks, the Deep State. They’re unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it’s something big, very very big. Tremendous, in fact." + }, + "prompt_tokens": 100, + "output_tokens": 220, + "prompt_cost": 0.00001, + "output_cost": 0.0002, + "finish_reason": "stop", + "messages": [ + { + "role": "user", + "content": "What really happened at Roswell?" + } + ], + "prompt": { + "model": "gpt-4", + "template": [ + { + "role": "system", + "content": "You are {{person}}. Answer questions as this person. Do not break character." + } + ] + }, + "created_at": "2024-07-19T00:29:35.178992", + "provider_latency": 6.5931549072265625, + "inputs": { + "person": "Trump" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "data_fIfEb1SoKZooqeFbi9IFs", + "prompt_id": "pr_3usCu3dAkgrXTlufrvPs7", + "version_id": "prv_Wu6zx1lAWJRqOyL8nWuZk" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts/log \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"path\": \"persona\",\n \"output_message\": {\n \"role\": \"assistant\",\n \"content\": \"Well, you know, there is so much secrecy involved in government, folks, it\\'s unbelievable. They don\\'t want to tell you everything. They don\\'t tell me everything! But about Roswell, it’s a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I\\'d love to go down and open up all the classified documents, believe me, I would. But they don\\'t let that happen. The Deep State, folks, the Deep State. They’re unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it’s something big, very very big. Tremendous, in fact.\"\n },\n \"prompt_tokens\": 100,\n \"output_tokens\": 220,\n \"prompt_cost\": 0.00001,\n \"output_cost\": 0.0002,\n \"finish_reason\": \"stop\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What really happened at Roswell?\"\n }\n ],\n \"prompt\": {\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are {{person}}. Answer questions as this person. Do not break character.\"\n }\n ]\n },\n \"created_at\": \"2024-07-19T00:29:35.178992\",\n \"provider_latency\": 6.5931549072265625,\n \"inputs\": {\n \"person\": \"Trump\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.log(\n path=\"persona\",\n prompt={\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are {{person}}. Answer questions as this person. Do not break character.\",\n }\n ],\n },\n messages=[{\"role\": \"user\", \"content\": \"What really happened at Roswell?\"}],\n inputs={\"person\": \"Trump\"},\n created_at=datetime.datetime.fromisoformat(\n \"2024-07-19 00:29:35.178000+00:00\",\n ),\n provider_latency=6.5931549072265625,\n output_message={\n \"content\": \"Well, you know, there is so much secrecy involved in government, folks, it's unbelievable. They don't want to tell you everything. They don't tell me everything! But about Roswell, it’s a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I'd love to go down and open up all the classified documents, believe me, I would. But they don't let that happen. The Deep State, folks, the Deep State. They’re unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it’s something big, very very big. Tremendous, in fact.\",\n \"role\": \"assistant\",\n },\n prompt_tokens=100,\n output_tokens=220,\n prompt_cost=1e-05,\n output_cost=0.0002,\n finish_reason=\"stop\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.log({\n path: \"persona\",\n prompt: {\n model: \"gpt-4\",\n template: [{\n role: \"system\",\n content: \"You are {{person}}. Answer questions as this person. Do not break character.\"\n }]\n },\n messages: [{\n role: \"user\",\n content: \"What really happened at Roswell?\"\n }],\n inputs: {\n \"person\": \"Trump\"\n },\n createdAt: \"2024-07-19T00:29:35.178992\",\n providerLatency: 6.5931549072265625,\n outputMessage: {\n content: \"Well, you know, there is so much secrecy involved in government, folks, it's unbelievable. They don't want to tell you everything. They don't tell me everything! But about Roswell, it’s a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I'd love to go down and open up all the classified documents, believe me, I would. But they don't let that happen. The Deep State, folks, the Deep State. They’re unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it’s something big, very very big. Tremendous, in fact.\",\n role: \"assistant\"\n },\n promptTokens: 100,\n outputTokens: 220,\n promptCost: 0.00001,\n outputCost: 0.0002,\n finishReason: \"stop\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/log", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/prompts/log?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.log(\n path=\"persona\",\n prompt={\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are {{person}}. Answer questions as this person. Do not break character.\",\n }\n ],\n },\n messages=[{\"role\": \"user\", \"content\": \"What really happened at Roswell?\"}],\n inputs={\"person\": \"Trump\"},\n created_at=datetime.datetime.fromisoformat(\n \"2024-07-19 00:29:35.178000+00:00\",\n ),\n provider_latency=6.5931549072265625,\n output_message={\n \"content\": \"Well, you know, there is so much secrecy involved in government, folks, it's unbelievable. They don't want to tell you everything. They don't tell me everything! But about Roswell, it’s a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I'd love to go down and open up all the classified documents, believe me, I would. But they don't let that happen. The Deep State, folks, the Deep State. They’re unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it’s something big, very very big. Tremendous, in fact.\",\n \"role\": \"assistant\",\n },\n prompt_tokens=100,\n output_tokens=220,\n prompt_cost=1e-05,\n output_cost=0.0002,\n finish_reason=\"stop\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.log({\n path: \"persona\",\n prompt: {\n model: \"gpt-4\",\n template: [{\n role: \"system\",\n content: \"You are {{person}}. Answer questions as this person. Do not break character.\"\n }]\n },\n messages: [{\n role: \"user\",\n content: \"What really happened at Roswell?\"\n }],\n inputs: {\n \"person\": \"Trump\"\n },\n createdAt: \"2024-07-19T00:29:35.178992\",\n providerLatency: 6.5931549072265625,\n outputMessage: {\n content: \"Well, you know, there is so much secrecy involved in government, folks, it's unbelievable. They don't want to tell you everything. They don't tell me everything! But about Roswell, it’s a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I'd love to go down and open up all the classified documents, believe me, I would. But they don't let that happen. The Deep State, folks, the Deep State. They’re unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it’s something big, very very big. Tremendous, in fact.\",\n role: \"assistant\"\n },\n promptTokens: 100,\n outputTokens: 220,\n promptCost: 0.00001,\n outputCost: 0.0002,\n finishReason: \"stop\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.log(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluationId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "evaluation_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outputMessage: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "image_url.url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "high": "\"high\"", + "low": "\"low\"", + "auto": "\"auto\"" + }, + "templateString": "detail: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "image_url.detail" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "output_message.content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_message.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_message.tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "\"user\"", + "assistant": "\"assistant\"", + "system": "\"system\"", + "tool": "\"tool\"" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "output_message.role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "output_message.tool_calls" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "promptTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outputTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "promptCost: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_cost" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outputCost: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_cost" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "finishReason: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "finish_reason" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "messages: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "image_url.url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "high": "\"high\"", + "low": "\"low\"", + "auto": "\"auto\"" + }, + "templateString": "detail: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "image_url.detail" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "\"user\"", + "assistant": "\"assistant\"", + "system": "\"system\"", + "tool": "\"tool\"" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "messages" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "toolChoice: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"none\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"auto\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"required\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ToolChoice" + } + } + ], + "templateInput": { + "location": "BODY", + "path": "tool_choice" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "\"complete\"", + "chat": "\"chat\"", + "edit": "\"edit\"" + }, + "templateString": "endpoint: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.endpoint" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "template: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "\"user\"", + "assistant": "\"assistant\"", + "system": "\"system\"", + "tool": "\"tool\"" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessage" + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "prompt.template" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "openai": "\"openai\"", + "openai_azure": "\"openai_azure\"", + "mock": "\"mock\"", + "anthropic": "\"anthropic\"", + "bedrock": "\"bedrock\"", + "cohere": "\"cohere\"", + "replicate": "\"replicate\"", + "google": "\"google\"", + "groq": "\"groq\"" + }, + "templateString": "provider: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.provider" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "stop: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "prompt.stop" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "other: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.other" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "json_object": "\"json_object\"", + "json_schema": "\"json_schema\"" + }, + "templateString": "type: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.response_format.type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "jsonSchema: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.response_format.json_schema" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "tools: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "parameters" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.tools" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "linkedTools: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.linked_tools" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.attributes" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "output: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "createdAt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "created_at" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "error: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "error" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerLatency: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_latency" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "stdout: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stdout" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerRequest: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_request" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerResponse: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_response" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceDatapointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source_datapoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "traceParentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "trace_parent_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "batches: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "batches" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "promptLogRequestEnvironment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "save: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "save" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.update": { + "id": "endpoint_prompts.update", + "namespace": [ + "subpackage_prompts" + ], + "description": "Update a Log.\n\nUpdate the details of a Log with the given ID.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/log/" + }, + { + "type": "pathParameter", + "value": "log_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + }, + { + "key": "log_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Log." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessage" + } + }, + "description": "The message returned by the provider." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the prompt used to generate the output." + }, + { + "key": "output_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the output generated by the model." + }, + { + "key": "prompt_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the prompt." + }, + { + "key": "output_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the output." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Reason the generation finished." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_prompts:PromptLogUpdateRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: \n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. \n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. \n- `'required'` means the model can decide to call one or more of the provided tools. \n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created. " + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/id/log/log_id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "log_id": "log_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "output_message": { + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "role": "user", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ] + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "finish_reason": "finish_reason", + "messages": [ + { + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "role": "user", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ] + } + ], + "tool_choice": "none", + "prompt": { + "path": "path", + "id": "id", + "directory_id": "directory_id", + "model": "model", + "endpoint": "complete", + "template": "template", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "other": { + "key": "value" + }, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "tools": [ + { + "name": "name", + "description": "description" + } + ], + "linked_tools": [ + { + "name": "name", + "description": "description", + "id": "id", + "version_id": "version_id" + } + ], + "attributes": { + "key": "value" + }, + "commit_message": "commit_message", + "name": "name", + "version_id": "version_id", + "type": "prompt", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ], + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + }, + "start_time": "2024-01-15T09:30:00Z", + "end_time": "2024-01-15T09:30:00Z", + "output": "output", + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "provider_latency": 1.1, + "stdout": "stdout", + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "source_datapoint_id": "source_datapoint_id", + "trace_parent_id": "trace_parent_id", + "batches": [ + "batches" + ], + "user": "user", + "environment": "environment", + "save": true, + "id": "id", + "evaluator_logs": [ + { + "start_time": "2024-01-15T09:30:00Z", + "end_time": "2024-01-15T09:30:00Z", + "output": "output", + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "provider_latency": 1.1, + "stdout": "stdout", + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "parent_id": "parent_id", + "source_datapoint_id": "source_datapoint_id", + "trace_parent_id": "trace_parent_id", + "batches": [ + "batches" + ], + "user": "user", + "environment": "environment", + "save": true, + "judgment": true, + "id": "id", + "evaluator_logs": [], + "trace_flow_id": "trace_flow_id", + "trace_id": "trace_id", + "evaluator": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ], + "trace_flow_id": "trace_flow_id", + "trace_id": "trace_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/prompts/id/log/log_id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.update(\n id=\"id\",\n log_id=\"log_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.update(\"id\", \"log_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id/log/:log_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "log_id": ":log_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/prompts/:id/log/:log_id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.update(\n id=\"id\",\n log_id=\"log_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.update(\"id\", \"log_id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.update(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "log_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outputMessage: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "image_url.url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "high": "\"high\"", + "low": "\"low\"", + "auto": "\"auto\"" + }, + "templateString": "detail: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "image_url.detail" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "output_message.content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_message.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_message.tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "\"user\"", + "assistant": "\"assistant\"", + "system": "\"system\"", + "tool": "\"tool\"" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "output_message.role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "output_message.tool_calls" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "promptTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outputTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "promptCost: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_cost" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outputCost: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output_cost" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "finishReason: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "finish_reason" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "messages: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "image_url.url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "high": "\"high\"", + "low": "\"low\"", + "auto": "\"auto\"" + }, + "templateString": "detail: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "image_url.detail" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "\"user\"", + "assistant": "\"assistant\"", + "system": "\"system\"", + "tool": "\"tool\"" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "messages" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "toolChoice: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"none\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"auto\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"required\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ToolChoice" + } + } + ], + "templateInput": { + "location": "BODY", + "path": "tool_choice" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "output: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "createdAt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "created_at" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "error: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "error" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerLatency: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_latency" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "stdout: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stdout" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerRequest: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_request" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerResponse: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_response" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.call_stream": { + "id": "endpoint_prompts.call_stream", + "namespace": [ + "subpackage_prompts" + ], + "description": "Call a Prompt.\n\nCalling a Prompt calls the model provider before logging\nthe request, responses and metadata to Humanloop.\n\nYou can use query parameters `version_id`, or `environment`, to target\nan existing version of the Prompt. Otherwise the default deployed version will be chosen.\n\nInstead of targeting an existing version explicitly, you can instead pass in\nPrompt details in the request body. In this case, we will check if the details correspond\nto an existing version of the Prompt. If they do not, we will create a new version. This is helpful\nin the case where you are storing or deriving your Prompt details in code.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/prompts/call" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Prompt to log to." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed version to log to." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Prompt." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_prompts:PromptsCallStreamRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: \n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. \n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. \n- `'required'` means the model can decide to call one or more of the provided tools. \n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function." + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptKernelRequest" + } + }, + "description": "Details of your Prompt. A new Prompt version will be created if the provided details are new." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptCallStreamResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/call", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "output": "string", + "created_at": "2023-01-01T00:00:00Z", + "error": "string", + "provider_latency": 1, + "stdout": "string", + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ] + }, + "prompt_tokens": 0, + "output_tokens": 0, + "prompt_cost": 1, + "output_cost": 1, + "finish_reason": "string", + "index": 0, + "id": "string", + "prompt_id": "string", + "version_id": "string" + }, + { + "output": "string", + "created_at": "2023-01-01T00:00:00Z", + "error": "string", + "provider_latency": 1, + "stdout": "string", + "output_message": { + "content": "string", + "name": "string", + "tool_call_id": "string", + "role": "user", + "tool_calls": [ + { + "id": "string", + "type": "function", + "function": { + "name": "string", + "arguments": "string" + } + } + ] + }, + "prompt_tokens": 0, + "output_tokens": 0, + "prompt_cost": 1, + "output_cost": 1, + "finish_reason": "string", + "index": 0, + "id": "string", + "prompt_id": "string", + "version_id": "string" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/prompts/call?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.prompts.call_stream(\n version_id=\"string\",\n environment=\"string\",\n path=\"string\",\n id=\"string\",\n messages=[\n {\n \"content\": \"string\",\n \"name\": \"string\",\n \"tool_call_id\": \"string\",\n \"role\": \"user\",\n \"tool_calls\": [\n {\n \"id\": \"string\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"string\",\n \"arguments\": {\"key\": \"value\"},\n },\n }\n ],\n }\n ],\n prompt={\n \"model\": \"string\",\n \"endpoint\": \"complete\",\n \"template\": \"string\",\n \"provider\": \"openai\",\n \"max_tokens\": 1,\n \"temperature\": 1.1,\n \"top_p\": 1.1,\n \"stop\": \"string\",\n \"presence_penalty\": 1.1,\n \"frequency_penalty\": 1.1,\n \"other\": {\"string\": {\"key\": \"value\"}},\n \"seed\": 1,\n \"response_format\": {\n \"type\": \"json_object\",\n \"json_schema\": {\"string\": {\"key\": \"value\"}},\n },\n \"tools\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"strict\": {\"key\": \"value\"},\n \"parameters\": {\"key\": \"value\"},\n }\n ],\n \"linked_tools\": [\"string\"],\n \"attributes\": {\"string\": {\"key\": \"value\"}},\n },\n inputs={\"string\": {\"key\": \"value\"}},\n source=\"string\",\n metadata={\"string\": {\"key\": \"value\"}},\n start_time=datetime.datetime.fromisoformat(\n \"2024-01-15 09:30:00+00:00\",\n ),\n end_time=datetime.datetime.fromisoformat(\n \"2024-01-15 09:30:00+00:00\",\n ),\n source_datapoint_id=\"string\",\n trace_parent_id=\"string\",\n batches=[\"string\"],\n user=\"string\",\n prompts_call_stream_request_environment=\"string\",\n save=True,\n provider_api_keys={\n \"openai\": \"string\",\n \"ai_21\": \"string\",\n \"mock\": \"string\",\n \"anthropic\": \"string\",\n \"bedrock\": \"string\",\n \"cohere\": \"string\",\n \"openai_azure\": \"string\",\n \"openai_azure_endpoint\": \"string\",\n },\n num_samples=1,\n return_inputs=True,\n logprobs=1,\n suffix=\"string\",\n)\nfor chunk in response:\n yield chunk\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.callStream({\n versionId: \"string\",\n environment: \"string\",\n path: \"string\",\n id: \"string\",\n messages: [{\n content: \"string\",\n name: \"string\",\n toolCallId: \"string\",\n role: \"user\",\n toolCalls: [{\n id: \"string\",\n type: \"function\",\n function: {\n name: \"string\",\n arguments: undefined\n }\n }]\n }],\n toolChoice: \"none\",\n prompt: {\n model: \"string\",\n endpoint: \"complete\",\n template: \"string\",\n provider: \"openai\",\n maxTokens: 1,\n temperature: 1.1,\n topP: 1.1,\n stop: \"string\",\n presencePenalty: 1.1,\n frequencyPenalty: 1.1,\n other: {\n \"string\": {\n \"key\": \"value\"\n }\n },\n seed: 1,\n responseFormat: {\n type: \"json_object\",\n jsonSchema: {}\n },\n tools: [{\n name: \"string\",\n description: \"string\",\n strict: undefined,\n parameters: undefined\n }],\n linkedTools: [\"string\"],\n attributes: {\n \"string\": {\n \"key\": \"value\"\n }\n }\n },\n inputs: {\n \"string\": {\n \"key\": \"value\"\n }\n },\n source: \"string\",\n metadata: {\n \"string\": {\n \"key\": \"value\"\n }\n },\n startTime: \"2024-01-15T09:30:00Z\",\n endTime: \"2024-01-15T09:30:00Z\",\n sourceDatapointId: \"string\",\n traceParentId: \"string\",\n batches: [\"string\"],\n user: \"string\",\n promptsCallStreamRequestEnvironment: \"string\",\n save: true,\n providerApiKeys: {\n openai: \"string\",\n ai21: \"string\",\n mock: \"string\",\n anthropic: \"string\",\n bedrock: \"string\",\n cohere: \"string\",\n openaiAzure: \"string\",\n openaiAzureEndpoint: \"string\"\n },\n numSamples: 1,\n returnInputs: true,\n logprobs: 1,\n suffix: \"string\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/call", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": true + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/prompts/call?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.prompts.call_stream(\n version_id=\"string\",\n environment=\"string\",\n path=\"string\",\n id=\"string\",\n messages=[\n {\n \"content\": \"string\",\n \"name\": \"string\",\n \"tool_call_id\": \"string\",\n \"role\": \"user\",\n \"tool_calls\": [\n {\n \"id\": \"string\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"string\",\n \"arguments\": {\"key\": \"value\"},\n },\n }\n ],\n }\n ],\n prompt={\n \"model\": \"string\",\n \"endpoint\": \"complete\",\n \"template\": \"string\",\n \"provider\": \"openai\",\n \"max_tokens\": 1,\n \"temperature\": 1.1,\n \"top_p\": 1.1,\n \"stop\": \"string\",\n \"presence_penalty\": 1.1,\n \"frequency_penalty\": 1.1,\n \"other\": {\"string\": {\"key\": \"value\"}},\n \"seed\": 1,\n \"response_format\": {\n \"type\": \"json_object\",\n \"json_schema\": {\"string\": {\"key\": \"value\"}},\n },\n \"tools\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"strict\": {\"key\": \"value\"},\n \"parameters\": {\"key\": \"value\"},\n }\n ],\n \"linked_tools\": [\"string\"],\n \"attributes\": {\"string\": {\"key\": \"value\"}},\n },\n inputs={\"string\": {\"key\": \"value\"}},\n source=\"string\",\n metadata={\"string\": {\"key\": \"value\"}},\n start_time=datetime.datetime.fromisoformat(\n \"2024-01-15 09:30:00+00:00\",\n ),\n end_time=datetime.datetime.fromisoformat(\n \"2024-01-15 09:30:00+00:00\",\n ),\n source_datapoint_id=\"string\",\n trace_parent_id=\"string\",\n batches=[\"string\"],\n user=\"string\",\n prompts_call_stream_request_environment=\"string\",\n save=True,\n provider_api_keys={\n \"openai\": \"string\",\n \"ai_21\": \"string\",\n \"mock\": \"string\",\n \"anthropic\": \"string\",\n \"bedrock\": \"string\",\n \"cohere\": \"string\",\n \"openai_azure\": \"string\",\n \"openai_azure_endpoint\": \"string\",\n },\n num_samples=1,\n return_inputs=True,\n logprobs=1,\n suffix=\"string\",\n)\nfor chunk in response:\n yield chunk\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.callStream({\n versionId: \"string\",\n environment: \"string\",\n path: \"string\",\n id: \"string\",\n messages: [{\n content: \"string\",\n name: \"string\",\n toolCallId: \"string\",\n role: \"user\",\n toolCalls: [{\n id: \"string\",\n type: \"function\",\n function: {\n name: \"string\",\n arguments: undefined\n }\n }]\n }],\n toolChoice: \"none\",\n prompt: {\n model: \"string\",\n endpoint: \"complete\",\n template: \"string\",\n provider: \"openai\",\n maxTokens: 1,\n temperature: 1.1,\n topP: 1.1,\n stop: \"string\",\n presencePenalty: 1.1,\n frequencyPenalty: 1.1,\n other: {\n \"string\": {\n \"key\": \"value\"\n }\n },\n seed: 1,\n responseFormat: {\n type: \"json_object\",\n jsonSchema: {}\n },\n tools: [{\n name: \"string\",\n description: \"string\",\n strict: undefined,\n parameters: undefined\n }],\n linkedTools: [\"string\"],\n attributes: {\n \"string\": {\n \"key\": \"value\"\n }\n }\n },\n inputs: {\n \"string\": {\n \"key\": \"value\"\n }\n },\n source: \"string\",\n metadata: {\n \"string\": {\n \"key\": \"value\"\n }\n },\n startTime: \"2024-01-15T09:30:00Z\",\n endTime: \"2024-01-15T09:30:00Z\",\n sourceDatapointId: \"string\",\n traceParentId: \"string\",\n batches: [\"string\"],\n user: \"string\",\n promptsCallStreamRequestEnvironment: \"string\",\n save: true,\n providerApiKeys: {\n openai: \"string\",\n ai21: \"string\",\n mock: \"string\",\n anthropic: \"string\",\n bedrock: \"string\",\n cohere: \"string\",\n openaiAzure: \"string\",\n openaiAzureEndpoint: \"string\"\n },\n numSamples: 1,\n returnInputs: true,\n logprobs: 1,\n suffix: \"string\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.call(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "messages: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "image_url.url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "high": "Humanloop.ImageUrlDetail.High", + "low": "Humanloop.ImageUrlDetail.Low", + "auto": "Humanloop.ImageUrlDetail.Auto" + }, + "templateString": "detail: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "image_url.detail" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "messages" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "toolChoice: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"none\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"auto\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"required\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ToolChoice" + } + } + ], + "templateInput": { + "location": "BODY", + "path": "tool_choice" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "Humanloop.ModelEndpoints.Complete", + "chat": "Humanloop.ModelEndpoints.Chat", + "edit": "Humanloop.ModelEndpoints.Edit" + }, + "templateString": "endpoint: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.endpoint" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "template: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessage" + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "prompt.template" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "openai": "Humanloop.ModelProviders.Openai", + "openai_azure": "Humanloop.ModelProviders.OpenaiAzure", + "mock": "Humanloop.ModelProviders.Mock", + "anthropic": "Humanloop.ModelProviders.Anthropic", + "bedrock": "Humanloop.ModelProviders.Bedrock", + "cohere": "Humanloop.ModelProviders.Cohere", + "replicate": "Humanloop.ModelProviders.Replicate", + "google": "Humanloop.ModelProviders.Google", + "groq": "Humanloop.ModelProviders.Groq" + }, + "templateString": "provider: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.provider" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "stop: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "prompt.stop" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "other: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.other" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "json_object": "Humanloop.ResponseFormatType.JsonObject", + "json_schema": "Humanloop.ResponseFormatType.JsonSchema" + }, + "templateString": "type: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.response_format.type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "jsonSchema: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.response_format.json_schema" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "tools: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "parameters" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.tools" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "linkedTools: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.linked_tools" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.attributes" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceDatapointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source_datapoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "traceParentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "trace_parent_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "batches: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "batches" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "promptsCallRequestEnvironment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "save: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "save" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerApiKeys: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "openai: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.openai" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "ai21: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.ai21" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "mock: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.mock" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "anthropic: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.anthropic" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "bedrock: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.bedrock" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cohere: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.cohere" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "openaiAzure: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.openai_azure" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "openaiAzureEndpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.openai_azure_endpoint" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numSamples: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_samples" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "returnInputs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "return_inputs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "logprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "suffix: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "suffix" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.call": { + "id": "endpoint_prompts.call", + "namespace": [ + "subpackage_prompts" + ], + "description": "Call a Prompt.\n\nCalling a Prompt calls the model provider before logging\nthe request, responses and metadata to Humanloop.\n\nYou can use query parameters `version_id`, or `environment`, to target\nan existing version of the Prompt. Otherwise the default deployed version will be chosen.\n\nInstead of targeting an existing version explicitly, you can instead pass in\nPrompt details in the request body. In this case, we will check if the details correspond\nto an existing version of the Prompt. If they do not, we will create a new version. This is helpful\nin the case where you are storing or deriving your Prompt details in code.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/prompts/call" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Prompt to log to." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed version to log to." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Prompt." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_prompts:PromptsCallRequestToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported: \n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. \n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. \n- `'required'` means the model can decide to call one or more of the provided tools. \n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function." + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptKernelRequest" + } + }, + "description": "Details of your Prompt. A new Prompt version will be created if the provided details are new." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "provider_api_keys", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProviderApiKeys" + } + }, + "description": "API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization." + }, + { + "key": "num_samples", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "The number of generations." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently." + }, + { + "key": "return_inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Include the log probabilities of the top n tokens in the provider_response" + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The suffix that comes after a completion of inserted text. Useful for completions that act like inserts." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptCallResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/call", + "responseStatusCode": 200, + "name": "Supplying Prompt with Tool", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "path": "persona", + "messages": [ + { + "role": "user", + "content": "latest apple" + } + ], + "prompt": { + "model": "gpt-4", + "template": [ + { + "role": "system", + "content": "You are stockbot. Return latest prices." + } + ], + "tools": [ + { + "name": "get_stock_price", + "description": "Get current stock price", + "parameters": { + "type": "object", + "properties": { + "ticker_symbol": { + "type": "string", + "name": "Ticker Symbol", + "description": "Ticker symbol of the stock" + } + }, + "required": [] + } + } + ] + } + } + }, + "responseBody": { + "type": "json", + "value": { + "prompt": { + "path": "persona", + "id": "pr_3usCu3dAkgrXTlufrvPs7", + "model": "gpt-4", + "name": "persona", + "version_id": "prv_Wu6zx1lAWJRqOyL8nWuZk", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "person" + } + ], + "template": [ + { + "role": "system", + "content": "You are {{person}}. Answer any questions as this person. Do not break character." + } + ], + "provider": "openai", + "type": "prompt" + }, + "id": "data_fIfEb1SoKZooqeFbi9IFs", + "logs": [ + { + "index": 0, + "output": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time.\n People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!", + "created_at": "2024-05-01T12:00:00Z", + "output_message": { + "role": "assistant", + "content": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time.\n People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!" + }, + "prompt_tokens": 34, + "output_tokens": 125, + "finish_reason": "stop" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts/call \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"path\": \"persona\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"latest apple\"\n }\n ],\n \"prompt\": {\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are stockbot. Return latest prices.\"\n }\n ],\n \"tools\": [\n {\n \"name\": \"get_stock_price\",\n \"description\": \"Get current stock price\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"ticker_symbol\": {\n \"type\": \"string\",\n \"name\": \"Ticker Symbol\",\n \"description\": \"Ticker symbol of the stock\"\n }\n },\n \"required\": []\n }\n }\n ]\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.call(\n path=\"persona\",\n prompt={\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are stockbot. Return latest prices.\",\n }\n ],\n \"tools\": [\n {\n \"name\": \"get_stock_price\",\n \"description\": \"Get current stock price\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"ticker_symbol\": {\n \"type\": \"string\",\n \"name\": \"Ticker Symbol\",\n \"description\": \"Ticker symbol of the stock\",\n }\n },\n \"required\": [],\n },\n }\n ],\n },\n messages=[{\"role\": \"user\", \"content\": \"latest apple\"}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.call({\n path: \"persona\",\n prompt: {\n model: \"gpt-4\",\n template: [{\n role: \"system\",\n content: \"You are stockbot. Return latest prices.\"\n }],\n tools: [{\n name: \"get_stock_price\",\n description: \"Get current stock price\",\n parameters: {\n \"type\": \"object\",\n \"properties\": {\n \"ticker_symbol\": {\n \"type\": \"string\",\n \"name\": \"Ticker Symbol\",\n \"description\": \"Ticker symbol of the stock\"\n }\n },\n \"required\": []\n }\n }]\n },\n messages: [{\n role: \"user\",\n content: \"latest apple\"\n }]\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/call", + "responseStatusCode": 200, + "name": "Supplying Prompt", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false, + "path": "persona", + "messages": [ + { + "role": "user", + "content": "What really happened at Roswell?" + } + ], + "prompt": { + "model": "gpt-4", + "template": [ + { + "role": "system", + "content": "You are {{person}}. Answer any questions as this person. Do not break character." + } + ] + }, + "inputs": { + "person": "Trump" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "prompt": { + "path": "persona", + "id": "pr_3usCu3dAkgrXTlufrvPs7", + "model": "gpt-4", + "name": "persona", + "version_id": "prv_Wu6zx1lAWJRqOyL8nWuZk", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "person" + } + ], + "template": [ + { + "role": "system", + "content": "You are {{person}}. Answer any questions as this person. Do not break character." + } + ], + "provider": "openai", + "type": "prompt" + }, + "id": "data_fIfEb1SoKZooqeFbi9IFs", + "logs": [ + { + "index": 0, + "output": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time.\n People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!", + "created_at": "2024-05-01T12:00:00Z", + "output_message": { + "role": "assistant", + "content": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time.\n People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!" + }, + "prompt_tokens": 34, + "output_tokens": 125, + "finish_reason": "stop" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts/call \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false,\n \"path\": \"persona\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What really happened at Roswell?\"\n }\n ],\n \"prompt\": {\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are {{person}}. Answer any questions as this person. Do not break character.\"\n }\n ]\n },\n \"inputs\": {\n \"person\": \"Trump\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.call(\n path=\"persona\",\n prompt={\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are {{person}}. Answer any questions as this person. Do not break character.\",\n }\n ],\n },\n messages=[{\"role\": \"user\", \"content\": \"What really happened at Roswell?\"}],\n inputs={\"person\": \"Trump\"},\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.call({\n path: \"persona\",\n prompt: {\n model: \"gpt-4\",\n template: [{\n role: \"system\",\n content: \"You are {{person}}. Answer any questions as this person. Do not break character.\"\n }]\n },\n messages: [{\n role: \"user\",\n content: \"What really happened at Roswell?\"\n }],\n inputs: {\n \"person\": \"Trump\"\n }\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/call", + "responseStatusCode": 200, + "name": "By ID", + "pathParameters": {}, + "queryParameters": { + "version_id": "prv_Wu6zx1lAWJRqOyL8nWuZk" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "path": "persona", + "messages": [ + { + "role": "user", + "content": "What really happened at Roswell?" + } + ], + "inputs": { + "person": "Trump" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "prompt": { + "path": "persona", + "id": "pr_3usCu3dAkgrXTlufrvPs7", + "model": "gpt-4", + "name": "persona", + "version_id": "prv_Wu6zx1lAWJRqOyL8nWuZk", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "person" + } + ], + "template": [ + { + "role": "system", + "content": "You are {{person}}. Answer any questions as this person. Do not break character." + } + ], + "provider": "openai", + "type": "prompt" + }, + "id": "data_fIfEb1SoKZooqeFbi9IFs", + "logs": [ + { + "index": 0, + "output": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time.\n People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!", + "created_at": "2024-05-01T12:00:00Z", + "output_message": { + "role": "assistant", + "content": "Well, let me tell you, there are a lot of stories about Roswell, and I hear them all the time.\n People love to talk about Roswell. So many theories, so many ideas. Some folks believe it was a weather balloon, others say it was something out of this world. Believe me, there's plenty that we don't know. Very interesting to look into, but the truth, well, it might still be out there. Could be a great story, who knows? But what I do know, folks, is that we have to keep our eyes open and always be on the lookout for the truth!" + }, + "prompt_tokens": 34, + "output_tokens": 125, + "finish_reason": "stop" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/prompts/call?version_id=prv_Wu6zx1lAWJRqOyL8nWuZk\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"path\": \"persona\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"What really happened at Roswell?\"\n }\n ],\n \"inputs\": {\n \"person\": \"Trump\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.call(\n version_id=\"prv_Wu6zx1lAWJRqOyL8nWuZk\",\n path=\"persona\",\n messages=[{\"role\": \"user\", \"content\": \"What really happened at Roswell?\"}],\n inputs={\"person\": \"Trump\"},\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.call({\n versionId: \"prv_Wu6zx1lAWJRqOyL8nWuZk\",\n path: \"persona\",\n messages: [{\n role: \"user\",\n content: \"What really happened at Roswell?\"\n }],\n inputs: {\n \"person\": \"Trump\"\n }\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/call", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/prompts/call?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"stream\": false\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.call(\n path=\"persona\",\n prompt={\n \"model\": \"gpt-4\",\n \"template\": [\n {\n \"role\": \"system\",\n \"content\": \"You are stockbot. Return latest prices.\",\n }\n ],\n \"tools\": [\n {\n \"name\": \"get_stock_price\",\n \"description\": \"Get current stock price\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"ticker_symbol\": {\n \"type\": \"string\",\n \"name\": \"Ticker Symbol\",\n \"description\": \"Ticker symbol of the stock\",\n }\n },\n \"required\": [],\n },\n }\n ],\n },\n messages=[{\"role\": \"user\", \"content\": \"latest apple\"}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.call({\n path: \"persona\",\n prompt: {\n model: \"gpt-4\",\n template: [{\n role: \"system\",\n content: \"You are stockbot. Return latest prices.\"\n }],\n tools: [{\n name: \"get_stock_price\",\n description: \"Get current stock price\",\n parameters: {\n \"type\": \"object\",\n \"properties\": {\n \"ticker_symbol\": {\n \"type\": \"string\",\n \"name\": \"Ticker Symbol\",\n \"description\": \"Ticker symbol of the stock\"\n }\n },\n \"required\": []\n }\n }]\n },\n messages: [{\n role: \"user\",\n content: \"latest apple\"\n }]\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.call(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "messages: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "image_url.url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "high": "Humanloop.ImageUrlDetail.High", + "low": "Humanloop.ImageUrlDetail.Low", + "auto": "Humanloop.ImageUrlDetail.Auto" + }, + "templateString": "detail: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "image_url.detail" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "messages" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "toolChoice: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"none\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"auto\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "\"required\"", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ToolChoice" + } + } + ], + "templateInput": { + "location": "BODY", + "path": "tool_choice" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "Humanloop.ModelEndpoints.Complete", + "chat": "Humanloop.ModelEndpoints.Chat", + "edit": "Humanloop.ModelEndpoints.Edit" + }, + "templateString": "endpoint: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.endpoint" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "template: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessage" + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "prompt.template" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "openai": "Humanloop.ModelProviders.Openai", + "openai_azure": "Humanloop.ModelProviders.OpenaiAzure", + "mock": "Humanloop.ModelProviders.Mock", + "anthropic": "Humanloop.ModelProviders.Anthropic", + "bedrock": "Humanloop.ModelProviders.Bedrock", + "cohere": "Humanloop.ModelProviders.Cohere", + "replicate": "Humanloop.ModelProviders.Replicate", + "google": "Humanloop.ModelProviders.Google", + "groq": "Humanloop.ModelProviders.Groq" + }, + "templateString": "provider: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.provider" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "stop: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "prompt.stop" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "other: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.other" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt.seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "json_object": "Humanloop.ResponseFormatType.JsonObject", + "json_schema": "Humanloop.ResponseFormatType.JsonSchema" + }, + "templateString": "type: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "prompt.response_format.type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "jsonSchema: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.response_format.json_schema" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "tools: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "parameters" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.tools" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "linkedTools: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.linked_tools" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "prompt.attributes" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceDatapointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source_datapoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "traceParentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "trace_parent_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "batches: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "batches" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "promptsCallRequestEnvironment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "save: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "save" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerApiKeys: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "openai: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.openai" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "ai21: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.ai21" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "mock: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.mock" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "anthropic: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.anthropic" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "bedrock: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.bedrock" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cohere: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.cohere" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "openaiAzure: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.openai_azure" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "openaiAzureEndpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_api_keys.openai_azure_endpoint" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numSamples: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_samples" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "returnInputs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "return_inputs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "logprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "suffix: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "suffix" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.list": { + "id": "endpoint_prompts.list", + "namespace": [ + "subpackage_prompts" + ], + "description": "Get a list of all Prompts.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/prompts" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page number for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Prompts to fetch." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for Prompt name." + }, + { + "key": "user_filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for users in the Prompt. This filter matches against both email address and name of users." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectSortBy" + } + }, + "description": "Field to sort Prompts by" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortOrder" + } + }, + "description": "Direction to sort by." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataPromptResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "size": 1 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "model": "gpt-4o", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ], + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + } + } + ], + "page": 0, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/prompts \\\n -H \"X-API-KEY: \" \\\n -d size=1", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.prompts.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.list({\n size: 1\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/prompts \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.prompts.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.list({\n size: 1\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "userFilter: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "user_filter" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "created_at": "Humanloop.ProjectSortBy.CreatedAt", + "updated_at": "Humanloop.ProjectSortBy.UpdatedAt", + "name": "Humanloop.ProjectSortBy.Name" + }, + "templateString": "sortBy: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "sort_by" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "asc": "Humanloop.SortOrder.Asc", + "desc": "Humanloop.SortOrder.Desc" + }, + "templateString": "order: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "order" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.upsert": { + "id": "endpoint_prompts.upsert", + "namespace": [ + "subpackage_prompts" + ], + "description": "Create a Prompt or update it with a new version if it already exists.\n\nPrompts are identified by the `ID` or their `path`. The parameters (i.e. the prompt template, temperature, model etc.) determine the versions of the Prompt.\n\nIf you provide a commit message, then the new version will be committed;\notherwise it will be uncommitted. If you try to commit an already committed version,\nan exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/prompts" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Prompt." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used, e.g. `gpt-4`. See [supported models](https://humanloop.com/docs/supported-models)" + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "The provider model endpoint used." + }, + { + "key": "template", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_prompts:PromptRequestTemplate" + } + }, + "description": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_prompts:PromptRequestStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only `{\"type\": \"json_object\"}` is currently supported for chat." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolFunction" + } + } + }, + "description": "The tool specification that the model can choose to call if Tool calling is supported." + }, + { + "key": "linked_tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The IDs of the Tools in your organization that the model can choose to call if Tool calling is supported. The default deployed version of that tool is called." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Prompt. Helpful to separate Prompt versions from each other with details on how they were created or used." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts", + "responseStatusCode": 200, + "name": "Upsert prompt", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "gpt-4o", + "path": "Personal Projects/Coding Assistant", + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "model": "gpt-4o", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ], + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"gpt-4o\",\n \"path\": \"Personal Projects/Coding Assistant\",\n \"endpoint\": \"chat\",\n \"template\": [\n {\n \"content\": \"You are a helpful coding assistant specialising in {{language}}\",\n \"role\": \"system\"\n }\n ],\n \"provider\": \"openai\",\n \"max_tokens\": -1,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"presence_penalty\": 0,\n \"frequency_penalty\": 0,\n \"other\": {},\n \"tools\": [],\n \"linked_tools\": [],\n \"commit_message\": \"Initial commit\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.upsert(\n path=\"Personal Projects/Coding Assistant\",\n model=\"gpt-4o\",\n endpoint=\"chat\",\n template=[\n {\n \"content\": \"You are a helpful coding assistant specialising in {{language}}\",\n \"role\": \"system\",\n }\n ],\n provider=\"openai\",\n max_tokens=-1,\n temperature=0.7,\n top_p=1.0,\n presence_penalty=0.0,\n frequency_penalty=0.0,\n other={},\n tools=[],\n linked_tools=[],\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.upsert({\n path: \"Personal Projects/Coding Assistant\",\n model: \"gpt-4o\",\n endpoint: \"chat\",\n template: [{\n content: \"You are a helpful coding assistant specialising in {{language}}\",\n role: \"system\"\n }],\n provider: \"openai\",\n maxTokens: -1,\n temperature: 0.7,\n topP: 1,\n presencePenalty: 0,\n frequencyPenalty: 0,\n other: {},\n tools: [],\n linkedTools: [],\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.upsert(\n path=\"Personal Projects/Coding Assistant\",\n model=\"gpt-4o\",\n endpoint=\"chat\",\n template=[\n {\n \"content\": \"You are a helpful coding assistant specialising in {{language}}\",\n \"role\": \"system\",\n }\n ],\n provider=\"openai\",\n max_tokens=-1,\n temperature=0.7,\n top_p=1.0,\n presence_penalty=0.0,\n frequency_penalty=0.0,\n other={},\n tools=[],\n linked_tools=[],\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.upsert({\n path: \"Personal Projects/Coding Assistant\",\n model: \"gpt-4o\",\n endpoint: \"chat\",\n template: [{\n content: \"You are a helpful coding assistant specialising in {{language}}\",\n role: \"system\"\n }],\n provider: \"openai\",\n maxTokens: -1,\n temperature: 0.7,\n topP: 1,\n presencePenalty: 0,\n frequencyPenalty: 0,\n other: {},\n tools: [],\n linkedTools: [],\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.upsert(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "Humanloop.ModelEndpoints.Complete", + "chat": "Humanloop.ModelEndpoints.Chat", + "edit": "Humanloop.ModelEndpoints.Edit" + }, + "templateString": "endpoint: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "endpoint" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "template: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "image_url.url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "high": "Humanloop.ImageUrlDetail.High", + "low": "Humanloop.ImageUrlDetail.Low", + "auto": "Humanloop.ImageUrlDetail.Auto" + }, + "templateString": "detail: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "image_url.detail" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessage" + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "template" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "openai": "Humanloop.ModelProviders.Openai", + "openai_azure": "Humanloop.ModelProviders.OpenaiAzure", + "mock": "Humanloop.ModelProviders.Mock", + "anthropic": "Humanloop.ModelProviders.Anthropic", + "bedrock": "Humanloop.ModelProviders.Bedrock", + "cohere": "Humanloop.ModelProviders.Cohere", + "replicate": "Humanloop.ModelProviders.Replicate", + "google": "Humanloop.ModelProviders.Google", + "groq": "Humanloop.ModelProviders.Groq" + }, + "templateString": "provider: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "provider" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "stop: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "stop" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "other: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "other" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "json_object": "Humanloop.ResponseFormatType.JsonObject", + "json_schema": "Humanloop.ResponseFormatType.JsonSchema" + }, + "templateString": "type: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "response_format.type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "jsonSchema: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "response_format.json_schema" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "tools: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "parameters" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "tools" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "linkedTools: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "linked_tools" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.get": { + "id": "endpoint_prompts.get", + "namespace": [ + "subpackage_prompts" + ], + "description": "Retrieve the Prompt with the given ID.\n\nBy default, the deployed version of the Prompt is returned. Use the query parameters\n`version_id` or `environment` to target a specific version of the Prompt.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Prompt to retrieve." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment to retrieve a deployed Version from." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/pr_30gco7dx6JDq4200GVOHa", + "responseStatusCode": 200, + "name": "Get specific prompt", + "pathParameters": { + "id": "pr_30gco7dx6JDq4200GVOHa" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "model": "gpt-4o", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ], + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.get(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.get(\"pr_30gco7dx6JDq4200GVOHa\");\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/prompts/:id \\\n -H \"X-API-KEY: \" \\\n -d version_id=string \\\n -d environment=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.get(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.get(\"pr_30gco7dx6JDq4200GVOHa\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.delete": { + "id": "endpoint_prompts.delete", + "namespace": [ + "subpackage_prompts" + ], + "description": "Delete the Prompt with the given ID.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/pr_30gco7dx6JDq4200GVOHa", + "responseStatusCode": 204, + "name": "Delete prompt", + "pathParameters": { + "id": "pr_30gco7dx6JDq4200GVOHa" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.delete(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.delete(\"pr_30gco7dx6JDq4200GVOHa\");\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/prompts/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.delete(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.delete(\"pr_30gco7dx6JDq4200GVOHa\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.move": { + "id": "endpoint_prompts.move", + "namespace": [ + "subpackage_prompts" + ], + "description": "Move the Prompt to a different path or change the name.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Prompt including the Prompt name, which is used as a unique identifier." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Prompt." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/pr_30gco7dx6JDq4200GVOHa", + "responseStatusCode": 200, + "name": "Move prompt", + "pathParameters": { + "id": "pr_30gco7dx6JDq4200GVOHa" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "path": "new directory/new name" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "model": "gpt-4o", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ], + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"path\": \"new directory/new name\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.move(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n path=\"new directory/new name\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.move(\"pr_30gco7dx6JDq4200GVOHa\", {\n path: \"new directory/new name\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/prompts/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.move(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n path=\"new directory/new name\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.move(\"pr_30gco7dx6JDq4200GVOHa\", {\n path: \"new directory/new name\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.move(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.listVersions": { + "id": "endpoint_prompts.listVersions", + "namespace": [ + "subpackage_prompts" + ], + "description": "Get a list of all the versions of a Prompt.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VersionStatus" + } + }, + "description": "Filter versions by status: 'uncommitted', 'committed'. If no status is provided, all versions are returned." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to include Evaluator aggregate results for the versions in the response" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListPrompts" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/pr_30gco7dx6JDq4200GVOHa/versions", + "responseStatusCode": 200, + "name": "List versions", + "pathParameters": { + "id": "pr_30gco7dx6JDq4200GVOHa" + }, + "queryParameters": { + "status": "committed" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "model": "gpt-4o", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ], + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa/versions \\\n -H \"X-API-KEY: \" \\\n -d status=committed", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.list_versions(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n status=\"committed\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.listVersions(\"pr_30gco7dx6JDq4200GVOHa\", {\n status: \"committed\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id/versions", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "status": "uncommitted", + "evaluator_aggregates": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/prompts/:id/versions \\\n -H \"X-API-KEY: \" \\\n -d status=uncommitted \\\n -d evaluator_aggregates=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.list_versions(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n status=\"committed\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.listVersions(\"pr_30gco7dx6JDq4200GVOHa\", {\n status: \"committed\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.listVersions(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "uncommitted": "Humanloop.VersionStatus.Uncommitted", + "committed": "Humanloop.VersionStatus.Committed", + "deleted": "Humanloop.VersionStatus.Deleted" + }, + "templateString": "status: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "status" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorAggregates: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "evaluator_aggregates" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.commit": { + "id": "endpoint_prompts.commit", + "namespace": [ + "subpackage_prompts" + ], + "description": "Commit a version of the Prompt with a commit message.\n\nIf the version is already committed, an exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions/" + }, + { + "type": "pathParameter", + "value": "version_id" + }, + { + "type": "literal", + "value": "/commit" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Prompt." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CommitRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/pr_30gco7dx6JDq4200GVOHa/versions/prv_F34aba5f3asp0/commit", + "responseStatusCode": 200, + "name": "Commit version", + "pathParameters": { + "id": "pr_30gco7dx6JDq4200GVOHa", + "version_id": "prv_F34aba5f3asp0" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "Reiterated point about not discussing sentience" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "model": "gpt-4o", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ], + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa/versions/prv_F34aba5f3asp0/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"Reiterated point about not discussing sentience\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.commit(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n version_id=\"prv_F34aba5f3asp0\",\n commit_message=\"Reiterated point about not discussing sentience\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.commit(\"pr_30gco7dx6JDq4200GVOHa\", \"prv_F34aba5f3asp0\", {\n commitMessage: \"Reiterated point about not discussing sentience\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id/versions/:version_id/commit", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "version_id": ":version_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts/:id/versions/:version_id/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.commit(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n version_id=\"prv_F34aba5f3asp0\",\n commit_message=\"Reiterated point about not discussing sentience\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.commit(\"pr_30gco7dx6JDq4200GVOHa\", \"prv_F34aba5f3asp0\", {\n commitMessage: \"Reiterated point about not discussing sentience\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.commit(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "version_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.updateMonitoring": { + "id": "endpoint_prompts.updateMonitoring", + "namespace": [ + "subpackage_prompts" + ], + "description": "Activate and deactivate Evaluators for monitoring the Prompt.\n\nAn activated Evaluator will automatically be run on all new Logs\nwithin the Prompt for monitoring purposes.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorActivationDeactivationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/pr_30gco7dx6JDq4200GVOHa/evaluators", + "responseStatusCode": 200, + "name": "Add evaluator", + "pathParameters": { + "id": "pr_30gco7dx6JDq4200GVOHa" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "activate": [ + { + "evaluator_version_id": "evv_1abc4308abd" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "model": "gpt-4o", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ], + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"activate\": [\n {\n \"evaluator_version_id\": \"evv_1abc4308abd\"\n }\n ]\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.update_monitoring(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n activate=[{\"evaluator_version_id\": \"evv_1abc4308abd\"}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.updateMonitoring(\"pr_30gco7dx6JDq4200GVOHa\", {\n activate: [{\n evaluatorVersionId: \"evv_1abc4308abd\"\n }]\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id/evaluators", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/prompts/:id/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.update_monitoring(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n activate=[{\"evaluator_version_id\": \"evv_1abc4308abd\"}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.updateMonitoring(\"pr_30gco7dx6JDq4200GVOHa\", {\n activate: [{\n evaluatorVersionId: \"evv_1abc4308abd\"\n }]\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.updateMonitoring(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "activate: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorVersionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_version_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environmentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "activate" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "deactivate: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorVersionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_version_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environmentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "deactivate" + } + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.setDeployment": { + "id": "endpoint_prompts.setDeployment", + "namespace": [ + "subpackage_prompts" + ], + "description": "Deploy Prompt to an Environment.\n\nSet the deployed version for the specified Environment. This Prompt\nwill be used for calls made to the Prompt in this Environment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to deploy the Version to." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Prompt." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PromptResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/id/environments/environment_id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "environment_id": "environment_id" + }, + "queryParameters": { + "version_id": "version_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ], + "directory_id": "directory_id", + "endpoint": "complete", + "template": "template", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "other": { + "key": "value" + }, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "tools": [ + { + "name": "name", + "description": "description", + "strict": true, + "parameters": { + "key": "value" + } + } + ], + "linked_tools": [ + { + "name": "name", + "description": "description", + "id": "id", + "version_id": "version_id", + "strict": true, + "parameters": { + "key": "value" + } + } + ], + "attributes": { + "key": "value" + }, + "commit_message": "commit_message", + "type": "prompt", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/prompts/id/environments/environment_id?version_id=version_id\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.set_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n version_id=\"version_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.setDeployment(\"id\", \"environment_id\", {\n versionId: \"version_id\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": { + "version_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/prompts/:id/environments/:environment_id?version_id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.set_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n version_id=\"version_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.setDeployment(\"id\", \"environment_id\", {\n versionId: \"version_id\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.setDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.removeDeployment": { + "id": "endpoint_prompts.removeDeployment", + "namespace": [ + "subpackage_prompts" + ], + "description": "Remove deployed Prompt from the Environment.\n\nRemove the deployed version for the specified Environment. This Prompt\nwill no longer be used for calls made to the Prompt in this Environment.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to remove the deployment from." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/id/environments/environment_id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id", + "environment_id": "environment_id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/prompts/id/environments/environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.remove_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.removeDeployment(\"id\", \"environment_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/prompts/:id/environments/:environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.remove_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.removeDeployment(\"id\", \"environment_id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.removeDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_prompts.listEnvironments": { + "id": "endpoint_prompts.listEnvironments", + "namespace": [ + "subpackage_prompts" + ], + "description": "List all Environments and their deployed versions for the Prompt.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileEnvironmentResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/prompts/pr_30gco7dx6JDq4200GVOHa/environments", + "responseStatusCode": 200, + "name": "List environments", + "pathParameters": { + "id": "pr_30gco7dx6JDq4200GVOHa" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "pr_30gco7dx6JDq4200GVOHa", + "created_at": "2024-05-01T12:00:00Z", + "name": "production", + "tag": "default", + "file": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + }, + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "model": "gpt-4o", + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ] + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.list_environments(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.listEnvironments(\"pr_30gco7dx6JDq4200GVOHa\");\n", + "generated": true + } + ] + } + }, + { + "path": "/prompts/:id/environments", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/prompts/:id/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.prompts.list_environments(\n id=\"pr_30gco7dx6JDq4200GVOHa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.prompts.listEnvironments(\"pr_30gco7dx6JDq4200GVOHa\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.prompts.listEnvironments(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.log": { + "id": "endpoint_tools.log", + "namespace": [ + "subpackage_tools" + ], + "description": "Log to a Tool.\n\nYou can use query parameters `version_id`, or `environment`, to target\nan existing version of the Tool. Otherwise the default deployed version will be chosen.\n\nInstead of targeting an existing version explicitly, you can instead pass in\nTool details in the request body. In this case, we will check if the details correspond\nto an existing version of the Tool, if not we will create a new version. This is helpful\nin the case where you are storing or deriving your Tool details in code.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/tools/log" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Tool to log to." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed version to log to." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Tool." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created. " + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "tool", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolKernelRequest" + } + }, + "description": "Details of your Tool. A new Tool version will be created if the provided details are new." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateToolLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/log", + "responseStatusCode": 200, + "name": "Tool log", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "path": "math-tool", + "output": "35", + "inputs": { + "a": 5, + "b": 7 + }, + "tool": { + "function": { + "name": "multiply", + "description": "Multiply two numbers", + "parameters": { + "type": "object", + "properties": { + "a": { + "type": "number" + }, + "b": { + "type": "number" + } + }, + "required": [ + "a", + "b" + ] + } + } + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "data_abc123", + "tool_id": "tl_def456", + "version_id": "tv_ghi789", + "session_id": "sesh_hw012" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/tools/log \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"path\": \"math-tool\",\n \"output\": \"35\",\n \"inputs\": {\n \"a\": 5,\n \"b\": 7\n },\n \"tool\": {\n \"function\": {\n \"name\": \"multiply\",\n \"description\": \"Multiply two numbers\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\n \"type\": \"number\"\n },\n \"b\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"a\",\n \"b\"\n ]\n }\n }\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.log(\n path=\"math-tool\",\n tool={\n \"function\": {\n \"name\": \"multiply\",\n \"description\": \"Multiply two numbers\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\"type\": \"number\"},\n \"b\": {\"type\": \"number\"},\n },\n \"required\": [\"a\", \"b\"],\n },\n }\n },\n inputs={\"a\": 5, \"b\": 7},\n output=\"35\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.log({\n path: \"math-tool\",\n tool: {\n function: {\n name: \"multiply\",\n description: \"Multiply two numbers\",\n parameters: {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\n \"type\": \"number\"\n },\n \"b\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"a\",\n \"b\"\n ]\n }\n }\n },\n inputs: {\n \"a\": 5,\n \"b\": 7\n },\n output: \"35\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/log", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/tools/log?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.log(\n path=\"math-tool\",\n tool={\n \"function\": {\n \"name\": \"multiply\",\n \"description\": \"Multiply two numbers\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\"type\": \"number\"},\n \"b\": {\"type\": \"number\"},\n },\n \"required\": [\"a\", \"b\"],\n },\n }\n },\n inputs={\"a\": 5, \"b\": 7},\n output=\"35\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.log({\n path: \"math-tool\",\n tool: {\n function: {\n name: \"multiply\",\n description: \"Multiply two numbers\",\n parameters: {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\n \"type\": \"number\"\n },\n \"b\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"a\",\n \"b\"\n ]\n }\n }\n },\n inputs: {\n \"a\": 5,\n \"b\": 7\n },\n output: \"35\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.log(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "output: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "createdAt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "created_at" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "error: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "error" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerLatency: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_latency" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "stdout: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stdout" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerRequest: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_request" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerResponse: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_response" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceDatapointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source_datapoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "traceParentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "trace_parent_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "batches: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "batches" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolLogRequestEnvironment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "save: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "save" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "tool: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "tool.function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "tool.function.description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "tool.function.strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "tool.function.parameters" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceCode: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "tool.source_code" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "setupValues: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "tool.setup_values" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "tool.attributes" + } + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.update": { + "id": "endpoint_tools.update", + "namespace": [ + "subpackage_tools" + ], + "description": "Update a Log.\n\nUpdate the details of a Log with the given ID.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/log/" + }, + { + "type": "pathParameter", + "value": "log_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + }, + { + "key": "log_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Log." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created. " + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/id/log/log_id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "log_id": "log_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "output_message": { + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "role": "user", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ] + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "finish_reason": "finish_reason", + "messages": [ + { + "content": "content", + "name": "name", + "tool_call_id": "tool_call_id", + "role": "user", + "tool_calls": [ + { + "id": "id", + "type": "function", + "function": { + "name": "name" + } + } + ] + } + ], + "tool_choice": "none", + "prompt": { + "path": "path", + "id": "id", + "directory_id": "directory_id", + "model": "model", + "endpoint": "complete", + "template": "template", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "other": { + "key": "value" + }, + "seed": 1, + "response_format": { + "type": "json_object", + "json_schema": { + "key": "value" + } + }, + "tools": [ + { + "name": "name", + "description": "description" + } + ], + "linked_tools": [ + { + "name": "name", + "description": "description", + "id": "id", + "version_id": "version_id" + } + ], + "attributes": { + "key": "value" + }, + "commit_message": "commit_message", + "name": "name", + "version_id": "version_id", + "type": "prompt", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ], + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + }, + "start_time": "2024-01-15T09:30:00Z", + "end_time": "2024-01-15T09:30:00Z", + "output": "output", + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "provider_latency": 1.1, + "stdout": "stdout", + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "source_datapoint_id": "source_datapoint_id", + "trace_parent_id": "trace_parent_id", + "batches": [ + "batches" + ], + "user": "user", + "environment": "environment", + "save": true, + "id": "id", + "evaluator_logs": [ + { + "start_time": "2024-01-15T09:30:00Z", + "end_time": "2024-01-15T09:30:00Z", + "output": "output", + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "provider_latency": 1.1, + "stdout": "stdout", + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "parent_id": "parent_id", + "source_datapoint_id": "source_datapoint_id", + "trace_parent_id": "trace_parent_id", + "batches": [ + "batches" + ], + "user": "user", + "environment": "environment", + "save": true, + "judgment": true, + "id": "id", + "evaluator_logs": [], + "trace_flow_id": "trace_flow_id", + "trace_id": "trace_id", + "evaluator": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ], + "trace_flow_id": "trace_flow_id", + "trace_id": "trace_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/tools/id/log/log_id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.update(\n id=\"id\",\n log_id=\"log_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.update(\"id\", \"log_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id/log/:log_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "log_id": ":log_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/tools/:id/log/:log_id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.update(\n id=\"id\",\n log_id=\"log_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.update(\"id\", \"log_id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.update(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "log_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "output: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "createdAt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "created_at" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "error: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "error" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerLatency: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_latency" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "stdout: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stdout" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerRequest: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_request" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerResponse: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_response" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.list": { + "id": "endpoint_tools.list", + "namespace": [ + "subpackage_tools" + ], + "description": "Get a list of all Tools.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/tools" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page offset for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Tools to fetch." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for Tool name." + }, + { + "key": "user_filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for users in the Tool. This filter matches against both email address and name of users." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectSortBy" + } + }, + "description": "Field to sort Tools by" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortOrder" + } + }, + "description": "Direction to sort by." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataToolResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools", + "responseStatusCode": 200, + "name": "List tools", + "pathParameters": {}, + "queryParameters": { + "size": 1 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + ], + "page": 0, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/tools \\\n -H \"X-API-KEY: \" \\\n -d size=1", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.tools.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.list({\n size: 1\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/tools \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.tools.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.list({\n size: 1\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "userFilter: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "user_filter" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "created_at": "Humanloop.ProjectSortBy.CreatedAt", + "updated_at": "Humanloop.ProjectSortBy.UpdatedAt", + "name": "Humanloop.ProjectSortBy.Name" + }, + "templateString": "sortBy: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "sort_by" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "asc": "Humanloop.SortOrder.Asc", + "desc": "Humanloop.SortOrder.Desc" + }, + "templateString": "order: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "order" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.upsert": { + "id": "endpoint_tools.upsert", + "namespace": [ + "subpackage_tools" + ], + "description": "Create a Tool or update it with a new version if it already exists.\n\nTools are identified by the `ID` or their `path`. The name, description and parameters determine the versions of the Tool.\n\nIf you provide a commit message, then the new version will be committed;\notherwise it will be uncommitted. If you try to commit an already committed version,\nan exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/tools" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Tool." + }, + { + "key": "function", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolFunction" + } + }, + "description": "Callable function specification of the Tool shown to the model for tool calling." + }, + { + "key": "source_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code source of the Tool." + }, + { + "key": "setup_values", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/" + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used." + }, + { + "key": "tool_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilesToolType" + } + }, + "description": "Type of Tool." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools", + "responseStatusCode": 200, + "name": "Create tool", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "path": "math-tool", + "function": { + "name": "multiply", + "description": "Multiply two numbers", + "parameters": { + "type": "object", + "properties": { + "a": { + "type": "number" + }, + "b": { + "type": "number" + } + }, + "required": [ + "a", + "b" + ] + } + }, + "commit_message": "Initial commit" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/tools \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"path\": \"math-tool\",\n \"function\": {\n \"name\": \"multiply\",\n \"description\": \"Multiply two numbers\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\n \"type\": \"number\"\n },\n \"b\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"a\",\n \"b\"\n ]\n }\n },\n \"commit_message\": \"Initial commit\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.upsert(\n path=\"math-tool\",\n function={\n \"name\": \"multiply\",\n \"description\": \"Multiply two numbers\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\"a\": {\"type\": \"number\"}, \"b\": {\"type\": \"number\"}},\n \"required\": [\"a\", \"b\"],\n },\n },\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.upsert({\n path: \"math-tool\",\n function: {\n name: \"multiply\",\n description: \"Multiply two numbers\",\n parameters: {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\n \"type\": \"number\"\n },\n \"b\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"a\",\n \"b\"\n ]\n }\n },\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/tools \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.upsert(\n path=\"math-tool\",\n function={\n \"name\": \"multiply\",\n \"description\": \"Multiply two numbers\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\"a\": {\"type\": \"number\"}, \"b\": {\"type\": \"number\"}},\n \"required\": [\"a\", \"b\"],\n },\n },\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.upsert({\n path: \"math-tool\",\n function: {\n name: \"multiply\",\n description: \"Multiply two numbers\",\n parameters: {\n \"type\": \"object\",\n \"properties\": {\n \"a\": {\n \"type\": \"number\"\n },\n \"b\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"a\",\n \"b\"\n ]\n }\n },\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.upsert(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "function.description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "function.strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "function.parameters" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceCode: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source_code" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "setupValues: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "setup_values" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "pinecone_search": "Humanloop.FilesToolType.PineconeSearch", + "google": "Humanloop.FilesToolType.Google", + "mock": "Humanloop.FilesToolType.Mock", + "snippet": "Humanloop.FilesToolType.Snippet", + "json_schema": "Humanloop.FilesToolType.JsonSchema", + "get_api_call": "Humanloop.FilesToolType.GetApiCall" + }, + "templateString": "toolType: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "tool_type" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.get": { + "id": "endpoint_tools.get", + "namespace": [ + "subpackage_tools" + ], + "description": "Retrieve the Tool with the given ID.\n\nBy default, the deployed version of the Tool is returned. Use the query parameters\n`version_id` or `environment` to target a specific version of the Tool.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Tool." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Tool to retrieve." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment to retrieve a deployed Version from." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi", + "responseStatusCode": 200, + "name": "Get specific tool", + "pathParameters": { + "id": "tl_789ghi" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/tools/tl_789ghi \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.get(\n id=\"tl_789ghi\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.get(\"tl_789ghi\");\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/tools/:id \\\n -H \"X-API-KEY: \" \\\n -d version_id=string \\\n -d environment=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.get(\n id=\"tl_789ghi\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.get(\"tl_789ghi\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.delete": { + "id": "endpoint_tools.delete", + "namespace": [ + "subpackage_tools" + ], + "description": "Delete the Tool with the given ID.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Tool." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi", + "responseStatusCode": 204, + "name": "Delete tool", + "pathParameters": { + "id": "tl_789ghi" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/tools/tl_789ghi \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.delete(\n id=\"tl_789ghi\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.delete(\"tl_789ghi\");\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/tools/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.delete(\n id=\"tl_789ghi\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.delete(\"tl_789ghi\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.move": { + "id": "endpoint_tools.move", + "namespace": [ + "subpackage_tools" + ], + "description": "Move the Tool to a different path or change the name.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Tool." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Tool including the Tool name, which is used as a unique identifier." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Tool, which is used as a unique identifier." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi", + "responseStatusCode": 200, + "name": "Move tool", + "pathParameters": { + "id": "tl_789ghi" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "path": "new directory/new name" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/tools/tl_789ghi \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"path\": \"new directory/new name\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.move(\n id=\"tl_789ghi\",\n path=\"new directory/new name\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.move(\"tl_789ghi\", {\n path: \"new directory/new name\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/tools/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.move(\n id=\"tl_789ghi\",\n path=\"new directory/new name\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.move(\"tl_789ghi\", {\n path: \"new directory/new name\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.move(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.listVersions": { + "id": "endpoint_tools.listVersions", + "namespace": [ + "subpackage_tools" + ], + "description": "Get a list of all the versions of a Tool.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Tool." + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VersionStatus" + } + }, + "description": "Filter versions by status: 'uncommitted', 'committed'. If no status is provided, all versions are returned." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to include Evaluator aggregate results for the versions in the response" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListTools" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi/versions", + "responseStatusCode": 200, + "name": "List versions", + "pathParameters": { + "id": "tl_789ghi" + }, + "queryParameters": { + "status": "committed" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/tools/tl_789ghi/versions \\\n -H \"X-API-KEY: \" \\\n -d status=committed", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.list_versions(\n id=\"tl_789ghi\",\n status=\"committed\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.listVersions(\"tl_789ghi\", {\n status: \"committed\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id/versions", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "status": "uncommitted", + "evaluator_aggregates": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/tools/:id/versions \\\n -H \"X-API-KEY: \" \\\n -d status=uncommitted \\\n -d evaluator_aggregates=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.list_versions(\n id=\"tl_789ghi\",\n status=\"committed\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.listVersions(\"tl_789ghi\", {\n status: \"committed\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.listVersions(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "uncommitted": "Humanloop.VersionStatus.Uncommitted", + "committed": "Humanloop.VersionStatus.Committed", + "deleted": "Humanloop.VersionStatus.Deleted" + }, + "templateString": "status: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "status" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorAggregates: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "evaluator_aggregates" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.commit": { + "id": "endpoint_tools.commit", + "namespace": [ + "subpackage_tools" + ], + "description": "Commit a version of the Tool with a commit message.\n\nIf the version is already committed, an exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions/" + }, + { + "type": "pathParameter", + "value": "version_id" + }, + { + "type": "literal", + "value": "/commit" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Tool." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Tool." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CommitRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi/versions/tv_012jkl/commit", + "responseStatusCode": 200, + "name": "Commit version", + "pathParameters": { + "id": "tl_789ghi", + "version_id": "tv_012jkl" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "Initial commit" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/tools/tl_789ghi/versions/tv_012jkl/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"Initial commit\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.commit(\n id=\"tl_789ghi\",\n version_id=\"tv_012jkl\",\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.commit(\"tl_789ghi\", \"tv_012jkl\", {\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id/versions/:version_id/commit", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "version_id": ":version_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/tools/:id/versions/:version_id/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.commit(\n id=\"tl_789ghi\",\n version_id=\"tv_012jkl\",\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.commit(\"tl_789ghi\", \"tv_012jkl\", {\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.commit(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "version_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.updateMonitoring": { + "id": "endpoint_tools.updateMonitoring", + "namespace": [ + "subpackage_tools" + ], + "description": "Activate and deactivate Evaluators for monitoring the Tool.\n\nAn activated Evaluator will automatically be run on all new Logs\nwithin the Tool for monitoring purposes.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorActivationDeactivationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi/evaluators", + "responseStatusCode": 200, + "name": "Update monitoring", + "pathParameters": { + "id": "tl_789ghi" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "activate": [ + { + "evaluator_version_id": "evv_1abc4308abd" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/tools/tl_789ghi/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"activate\": [\n {\n \"evaluator_version_id\": \"evv_1abc4308abd\"\n }\n ]\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.update_monitoring(\n id=\"tl_789ghi\",\n activate=[{\"evaluator_version_id\": \"evv_1abc4308abd\"}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.updateMonitoring(\"tl_789ghi\", {\n activate: [{\n evaluatorVersionId: \"evv_1abc4308abd\"\n }]\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id/evaluators", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/tools/:id/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.update_monitoring(\n id=\"tl_789ghi\",\n activate=[{\"evaluator_version_id\": \"evv_1abc4308abd\"}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.updateMonitoring(\"tl_789ghi\", {\n activate: [{\n evaluatorVersionId: \"evv_1abc4308abd\"\n }]\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.updateMonitoring(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "activate: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorVersionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_version_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environmentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "activate" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "deactivate: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorVersionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_version_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environmentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "deactivate" + } + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.setDeployment": { + "id": "endpoint_tools.setDeployment", + "namespace": [ + "subpackage_tools" + ], + "description": "Deploy Tool to an Environment.\n\nSet the deployed version for the specified Environment. This Prompt\nwill be used for calls made to the Tool in this Environment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Tool." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to deploy the Version to." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Tool." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi/environments/staging", + "responseStatusCode": 200, + "name": "Deploy", + "pathParameters": { + "id": "tl_789ghi", + "environment_id": "staging" + }, + "queryParameters": { + "version_id": "tv_012jkl" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "math-tool", + "id": "tl_789ghi", + "name": "math-tool", + "version_id": "tv_012jkl", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ], + "type": "tool" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/tools/tl_789ghi/environments/staging?version_id=tv_012jkl\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.set_deployment(\n id=\"tl_789ghi\",\n environment_id=\"staging\",\n version_id=\"tv_012jkl\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.setDeployment(\"tl_789ghi\", \"staging\", {\n versionId: \"tv_012jkl\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": { + "version_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/tools/:id/environments/:environment_id?version_id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.set_deployment(\n id=\"tl_789ghi\",\n environment_id=\"staging\",\n version_id=\"tv_012jkl\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.setDeployment(\"tl_789ghi\", \"staging\", {\n versionId: \"tv_012jkl\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.setDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.removeDeployment": { + "id": "endpoint_tools.removeDeployment", + "namespace": [ + "subpackage_tools" + ], + "description": "Remove deployed Tool from the Environment.\n\nRemove the deployed version for the specified Environment. This Tool\nwill no longer be used for calls made to the Tool in this Environment.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Tool." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to remove the deployment from." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi/environments/staging", + "responseStatusCode": 204, + "name": "Delete environment", + "pathParameters": { + "id": "tl_789ghi", + "environment_id": "staging" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/tools/tl_789ghi/environments/staging \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.remove_deployment(\n id=\"tl_789ghi\",\n environment_id=\"staging\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.removeDeployment(\"tl_789ghi\", \"staging\");\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/tools/:id/environments/:environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.remove_deployment(\n id=\"tl_789ghi\",\n environment_id=\"staging\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.removeDeployment(\"tl_789ghi\", \"staging\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.removeDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_tools.listEnvironments": { + "id": "endpoint_tools.listEnvironments", + "namespace": [ + "subpackage_tools" + ], + "description": "List all Environments and their deployed versions for the Tool.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Tool." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileEnvironmentResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/tools/tl_789ghi/environments", + "responseStatusCode": 200, + "name": "List environments", + "pathParameters": { + "id": "tl_789ghi" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "tl_789ghi", + "created_at": "2024-05-01T12:00:00Z", + "name": "production", + "tag": "default", + "file": { + "id": "tl_789ghi", + "path": "math-tool", + "name": "math-tool", + "version_id": "tv_012jkl", + "type": "tool", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "operation" + } + ] + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/tools/tl_789ghi/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.list_environments(\n id=\"tl_789ghi\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.listEnvironments(\"tl_789ghi\");\n", + "generated": true + } + ] + } + }, + { + "path": "/tools/:id/environments", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/tools/:id/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.tools.list_environments(\n id=\"tl_789ghi\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.tools.listEnvironments(\"tl_789ghi\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.tools.listEnvironments(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.list": { + "id": "endpoint_datasets.list", + "namespace": [ + "subpackage_datasets" + ], + "description": "List all Datasets.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page offset for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Datasets to fetch." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for Dataset name." + }, + { + "key": "user_filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for users in the Dataset. This filter matches against both email address and name of users." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectSortBy" + } + }, + "description": "Field to sort Datasets by" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortOrder" + } + }, + "description": "Direction to sort by." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets", + "responseStatusCode": 200, + "name": "List datasets", + "pathParameters": {}, + "queryParameters": { + "size": 1 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + } + ], + "page": 0, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets \\\n -H \"X-API-KEY: \" \\\n -d size=1", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.datasets.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.list({\n size: 1\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.datasets.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.list({\n size: 1\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "userFilter: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "user_filter" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "created_at": "Humanloop.ProjectSortBy.CreatedAt", + "updated_at": "Humanloop.ProjectSortBy.UpdatedAt", + "name": "Humanloop.ProjectSortBy.Name" + }, + "templateString": "sortBy: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "sort_by" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "asc": "Humanloop.SortOrder.Asc", + "desc": "Humanloop.SortOrder.Desc" + }, + "templateString": "order: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "order" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.upsert": { + "id": "endpoint_datasets.upsert", + "namespace": [ + "subpackage_datasets" + ], + "description": "Create a Dataset or update it with a new version if it already exists.\n\nDatasets are identified by the `ID` or their `path`. The datapoints determine the versions of the Dataset.\n\nBy default, the new Dataset version will be set to the list of Datapoints provided in\nthe request. You can also create a new version by adding or removing Datapoints from an existing version\nby specifying `action` as `add` or `remove` respectively. In this case, you may specify\nthe `version_id` or `environment` query parameters to identify the existing version to base\nthe new version on. If neither is provided, the default deployed version will be used.\n\nIf you provide a commit message, then the new version will be committed;\notherwise it will be uncommitted. If you try to commit an already committed version,\nan exception will be raised.\n\nHumanloop also deduplicates Datapoints. If you try to add a Datapoint that already\nexists, it will be ignored. If you intentionally want to add a duplicate Datapoint,\nyou can add a unique identifier to the Datapoint's inputs such as `{_dedupe_id: }`.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/datasets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the specific Dataset version to base the created Version on. Only used when `action` is `\"add\"` or `\"remove\"`." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed Version to base the created Version on. Only used when `action` is `\"add\"` or `\"remove\"`." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Dataset, including the name. This locates the Dataset in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Dataset." + }, + { + "key": "datapoints", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CreateDatapointRequest" + } + }, + "description": "The Datapoints to create this Dataset version with. Modify the `action` field to determine how these Datapoints are used." + }, + { + "key": "action", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UpdateDatesetAction" + } + }, + "description": "The action to take with the provided Datapoints.\n\n - If `\"set\"`, the created version will only contain the Datapoints provided in this request. \n - If `\"add\"`, the created version will contain the Datapoints provided in this request in addition to the Datapoints in the target version. \n - If `\"remove\"`, the created version will contain the Datapoints in the target version except for the Datapoints provided in this request. \n\nIf `\"add\"` or `\"remove\"`, one of the `version_id` or `environment` query parameters may be provided." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Dataset. Helpful to separate Dataset versions from each other with details on how they were created or used." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made. If provided, a committed version of the Dataset is created. Otherwise, an uncommitted version is created." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets", + "responseStatusCode": 200, + "name": "AddToDataset", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "datapoints": [ + { + "inputs": { + "question": "What is the capital of France?" + }, + "target": { + "answer": "Paris" + } + }, + { + "inputs": { + "question": "Who wrote Hamlet?" + }, + "target": { + "answer": "William Shakespeare" + } + } + ], + "path": "test-questions", + "action": "set", + "commit_message": "Add two new questions and answers" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "test-questions", + "id": "ds_mno345", + "name": "test-questions", + "version_id": "dsv_pqr678", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 4, + "type": "dataset" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/datasets \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"datapoints\": [\n {\n \"inputs\": {\n \"question\": \"What is the capital of France?\"\n },\n \"target\": {\n \"answer\": \"Paris\"\n }\n },\n {\n \"inputs\": {\n \"question\": \"Who wrote Hamlet?\"\n },\n \"target\": {\n \"answer\": \"William Shakespeare\"\n }\n }\n ],\n \"path\": \"test-questions\",\n \"action\": \"set\",\n \"commit_message\": \"Add two new questions and answers\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.upsert(\n path=\"test-questions\",\n datapoints=[\n {\n \"inputs\": {\"question\": \"What is the capital of France?\"},\n \"target\": {\"answer\": \"Paris\"},\n },\n {\n \"inputs\": {\"question\": \"Who wrote Hamlet?\"},\n \"target\": {\"answer\": \"William Shakespeare\"},\n },\n ],\n action=\"set\",\n commit_message=\"Add two new questions and answers\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.upsert({\n path: \"test-questions\",\n datapoints: [{\n inputs: {\n \"question\": \"What is the capital of France?\"\n },\n target: {\n \"answer\": \"Paris\"\n }\n }, {\n inputs: {\n \"question\": \"Who wrote Hamlet?\"\n },\n target: {\n \"answer\": \"William Shakespeare\"\n }\n }],\n action: \"set\",\n commitMessage: \"Add two new questions and answers\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets", + "responseStatusCode": 200, + "name": "CreateSupportDataset", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "datapoints": [ + { + "messages": [ + { + "role": "user", + "content": "How do i manage my organizations API keys?\n" + } + ], + "target": { + "response": "Hey, thanks for your questions. Here are steps for how to achieve: 1. Log in to the Humanloop Dashboard \n\n2. Click on \"Organization Settings.\"\n If you do not see this option, you might need to contact your organization admin to gain the necessary permissions.\n\n3. Within the settings or organization settings, select the option labeled \"API Keys\" on the left. Here you will be able to view and manage your API keys.\n\n4. You will see a list of existing API keys. You can perform various actions, such as:\n - **Generate New API Key:** Click on the \"Generate New Key\" button if you need a new API key.\n - **Revoke an API Key:** If you need to disable an existing key, find the key in the list and click the \"Revoke\" or \"Delete\" button.\n - **Copy an API Key:** If you need to use an existing key, you can copy it to your clipboard by clicking the \"Copy\" button next to the key.\n\n5. **Save and Secure API Keys:** Make sure to securely store any new or existing API keys you are using. Treat them like passwords and do not share them publicly.\n\nIf you encounter any issues or need further assistance, it might be helpful to engage with an engineer or your IT department to ensure you have the necessary permissions and support.\n\nWould you need help with anything else?" + } + }, + { + "messages": [ + { + "role": "user", + "content": "Hey, can do I use my code evaluator for monitoring my legal-copilot prompt?" + } + ], + "target": { + "response": "Hey, thanks for your questions. Here are steps for how to achieve: 1. Navigate to your Prompt dashboard. \n 2. Select the `Monitoring` button on the top right of the Prompt dashboard \n 3. Within the model select the Version of the Evaluator you want to turn on for monitoring. \n\nWould you need help with anything else?" + } + } + ], + "path": "datasets/support-queries", + "commit_message": "Add two new questions and answers" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "test-questions", + "id": "ds_mno345", + "name": "test-questions", + "version_id": "dsv_pqr678", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 4, + "type": "dataset" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/datasets \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"datapoints\": [\n {\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"How do i manage my organizations API keys?\\n\"\n }\n ],\n \"target\": {\n \"response\": \"Hey, thanks for your questions. Here are steps for how to achieve: 1. Log in to the Humanloop Dashboard \\n\\n2. Click on \\\"Organization Settings.\\\"\\n If you do not see this option, you might need to contact your organization admin to gain the necessary permissions.\\n\\n3. Within the settings or organization settings, select the option labeled \\\"API Keys\\\" on the left. Here you will be able to view and manage your API keys.\\n\\n4. You will see a list of existing API keys. You can perform various actions, such as:\\n - **Generate New API Key:** Click on the \\\"Generate New Key\\\" button if you need a new API key.\\n - **Revoke an API Key:** If you need to disable an existing key, find the key in the list and click the \\\"Revoke\\\" or \\\"Delete\\\" button.\\n - **Copy an API Key:** If you need to use an existing key, you can copy it to your clipboard by clicking the \\\"Copy\\\" button next to the key.\\n\\n5. **Save and Secure API Keys:** Make sure to securely store any new or existing API keys you are using. Treat them like passwords and do not share them publicly.\\n\\nIf you encounter any issues or need further assistance, it might be helpful to engage with an engineer or your IT department to ensure you have the necessary permissions and support.\\n\\nWould you need help with anything else?\"\n }\n },\n {\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Hey, can do I use my code evaluator for monitoring my legal-copilot prompt?\"\n }\n ],\n \"target\": {\n \"response\": \"Hey, thanks for your questions. Here are steps for how to achieve: 1. Navigate to your Prompt dashboard. \\n 2. Select the `Monitoring` button on the top right of the Prompt dashboard \\n 3. Within the model select the Version of the Evaluator you want to turn on for monitoring. \\n\\nWould you need help with anything else?\"\n }\n }\n ],\n \"path\": \"datasets/support-queries\",\n \"commit_message\": \"Add two new questions and answers\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.upsert(\n path=\"datasets/support-queries\",\n datapoints=[\n {\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"How do i manage my organizations API keys?\\n\",\n }\n ],\n \"target\": {\n \"response\": 'Hey, thanks for your questions. Here are steps for how to achieve: 1. Log in to the Humanloop Dashboard \\n\\n2. Click on \"Organization Settings.\"\\n If you do not see this option, you might need to contact your organization admin to gain the necessary permissions.\\n\\n3. Within the settings or organization settings, select the option labeled \"API Keys\" on the left. Here you will be able to view and manage your API keys.\\n\\n4. You will see a list of existing API keys. You can perform various actions, such as:\\n - **Generate New API Key:** Click on the \"Generate New Key\" button if you need a new API key.\\n - **Revoke an API Key:** If you need to disable an existing key, find the key in the list and click the \"Revoke\" or \"Delete\" button.\\n - **Copy an API Key:** If you need to use an existing key, you can copy it to your clipboard by clicking the \"Copy\" button next to the key.\\n\\n5. **Save and Secure API Keys:** Make sure to securely store any new or existing API keys you are using. Treat them like passwords and do not share them publicly.\\n\\nIf you encounter any issues or need further assistance, it might be helpful to engage with an engineer or your IT department to ensure you have the necessary permissions and support.\\n\\nWould you need help with anything else?'\n },\n },\n {\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Hey, can do I use my code evaluator for monitoring my legal-copilot prompt?\",\n }\n ],\n \"target\": {\n \"response\": \"Hey, thanks for your questions. Here are steps for how to achieve: 1. Navigate to your Prompt dashboard. \\n 2. Select the `Monitoring` button on the top right of the Prompt dashboard \\n 3. Within the model select the Version of the Evaluator you want to turn on for monitoring. \\n\\nWould you need help with anything else?\"\n },\n },\n ],\n commit_message=\"Add two new questions and answers\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.upsert({\n path: \"datasets/support-queries\",\n datapoints: [{\n messages: [{\n role: \"user\",\n content: \"How do i manage my organizations API keys?\\n\"\n }],\n target: {\n \"response\": \"Hey, thanks for your questions. Here are steps for how to achieve: 1. Log in to the Humanloop Dashboard \\n\\n2. Click on \\\"Organization Settings.\\\"\\n If you do not see this option, you might need to contact your organization admin to gain the necessary permissions.\\n\\n3. Within the settings or organization settings, select the option labeled \\\"API Keys\\\" on the left. Here you will be able to view and manage your API keys.\\n\\n4. You will see a list of existing API keys. You can perform various actions, such as:\\n - **Generate New API Key:** Click on the \\\"Generate New Key\\\" button if you need a new API key.\\n - **Revoke an API Key:** If you need to disable an existing key, find the key in the list and click the \\\"Revoke\\\" or \\\"Delete\\\" button.\\n - **Copy an API Key:** If you need to use an existing key, you can copy it to your clipboard by clicking the \\\"Copy\\\" button next to the key.\\n\\n5. **Save and Secure API Keys:** Make sure to securely store any new or existing API keys you are using. Treat them like passwords and do not share them publicly.\\n\\nIf you encounter any issues or need further assistance, it might be helpful to engage with an engineer or your IT department to ensure you have the necessary permissions and support.\\n\\nWould you need help with anything else?\"\n }\n }, {\n messages: [{\n role: \"user\",\n content: \"Hey, can do I use my code evaluator for monitoring my legal-copilot prompt?\"\n }],\n target: {\n \"response\": \"Hey, thanks for your questions. Here are steps for how to achieve: 1. Navigate to your Prompt dashboard. \\n 2. Select the `Monitoring` button on the top right of the Prompt dashboard \\n 3. Within the model select the Version of the Evaluator you want to turn on for monitoring. \\n\\nWould you need help with anything else?\"\n }\n }],\n commitMessage: \"Add two new questions and answers\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "datapoints": [ + {} + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/datasets?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"datapoints\": [\n {}\n ]\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.upsert(\n path=\"test-questions\",\n datapoints=[\n {\n \"inputs\": {\"question\": \"What is the capital of France?\"},\n \"target\": {\"answer\": \"Paris\"},\n },\n {\n \"inputs\": {\"question\": \"Who wrote Hamlet?\"},\n \"target\": {\"answer\": \"William Shakespeare\"},\n },\n ],\n action=\"set\",\n commit_message=\"Add two new questions and answers\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.upsert({\n path: \"datasets/support-queries\",\n datapoints: [{\n messages: [{\n role: \"user\",\n content: \"How do i manage my organizations API keys?\\n\"\n }],\n target: {\n \"response\": \"Hey, thanks for your questions. Here are steps for how to achieve: 1. Log in to the Humanloop Dashboard \\n\\n2. Click on \\\"Organization Settings.\\\"\\n If you do not see this option, you might need to contact your organization admin to gain the necessary permissions.\\n\\n3. Within the settings or organization settings, select the option labeled \\\"API Keys\\\" on the left. Here you will be able to view and manage your API keys.\\n\\n4. You will see a list of existing API keys. You can perform various actions, such as:\\n - **Generate New API Key:** Click on the \\\"Generate New Key\\\" button if you need a new API key.\\n - **Revoke an API Key:** If you need to disable an existing key, find the key in the list and click the \\\"Revoke\\\" or \\\"Delete\\\" button.\\n - **Copy an API Key:** If you need to use an existing key, you can copy it to your clipboard by clicking the \\\"Copy\\\" button next to the key.\\n\\n5. **Save and Secure API Keys:** Make sure to securely store any new or existing API keys you are using. Treat them like passwords and do not share them publicly.\\n\\nIf you encounter any issues or need further assistance, it might be helpful to engage with an engineer or your IT department to ensure you have the necessary permissions and support.\\n\\nWould you need help with anything else?\"\n }\n }, {\n messages: [{\n role: \"user\",\n content: \"Hey, can do I use my code evaluator for monitoring my legal-copilot prompt?\"\n }],\n target: {\n \"response\": \"Hey, thanks for your questions. Here are steps for how to achieve: 1. Navigate to your Prompt dashboard. \\n 2. Select the `Monitoring` button on the top right of the Prompt dashboard \\n 3. Within the model select the Version of the Evaluator you want to turn on for monitoring. \\n\\nWould you need help with anything else?\"\n }\n }],\n commitMessage: \"Add two new questions and answers\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.upsert(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "datapoints: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "messages: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "text: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "text" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:TextChatContent" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "imageUrl: {\n\t\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ImageChatContent" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "arguments: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "function.arguments" + } + ] + } + } + ] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "messages" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "target: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "unknown" + } + } + }, + { + "template": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "{\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "map", + "keyType": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueType": { + "type": "unknown" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": "target" + } + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "datapoints" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "set": "Humanloop.UpdateDatesetAction.Set", + "add": "Humanloop.UpdateDatesetAction.Add", + "remove": "Humanloop.UpdateDatesetAction.Remove" + }, + "templateString": "action: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "action" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.get": { + "id": "endpoint_datasets.get", + "namespace": [ + "subpackage_datasets" + ], + "description": "Retrieve the Dataset with the given ID.\n\nUnless `include_datapoints` is set to `true`, the response will not include\nthe Datapoints.\nUse the List Datapoints endpoint (`GET /{id}/datapoints`) to efficiently\nretrieve Datapoints for a large Dataset.\n\nBy default, the deployed version of the Dataset is returned. Use the query parameters\n`version_id` or `environment` to target a specific version of the Dataset.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Dataset to retrieve." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment to retrieve a deployed Version from." + }, + { + "key": "include_datapoints", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If set to `true`, include all Datapoints in the response. Defaults to `false`. Consider using the paginated List Datapoints endpoint instead." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/ds_b0baF1ca7652", + "responseStatusCode": 200, + "name": "Get dataset", + "pathParameters": { + "id": "ds_b0baF1ca7652" + }, + "queryParameters": { + "version_id": "dsv_6L78pqrdFi2xa", + "include_datapoints": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "datapoints": [ + { + "id": "dp_123456", + "inputs": { + "question": "What is the capital of France?" + }, + "target": { + "answer": "Paris" + } + }, + { + "id": "dp_789012", + "inputs": { + "question": "Who wrote Hamlet?" + }, + "target": { + "answer": "William Shakespeare" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets/ds_b0baF1ca7652 \\\n -H \"X-API-KEY: \" \\\n -d version_id=dsv_6L78pqrdFi2xa \\\n -d include_datapoints=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.get(\n id=\"ds_b0baF1ca7652\",\n version_id=\"dsv_6L78pqrdFi2xa\",\n include_datapoints=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.get(\"ds_b0baF1ca7652\", {\n versionId: \"dsv_6L78pqrdFi2xa\",\n includeDatapoints: true\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets/:id \\\n -H \"X-API-KEY: \" \\\n -d version_id=string \\\n -d environment=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.get(\n id=\"ds_b0baF1ca7652\",\n version_id=\"dsv_6L78pqrdFi2xa\",\n include_datapoints=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.get(\"ds_b0baF1ca7652\", {\n versionId: \"dsv_6L78pqrdFi2xa\",\n includeDatapoints: true\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "includeDatapoints: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "include_datapoints" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.delete": { + "id": "endpoint_datasets.delete", + "namespace": [ + "subpackage_datasets" + ], + "description": "Delete the Dataset with the given ID.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/datasets/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.delete(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.delete(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/datasets/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.delete(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.delete(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.move": { + "id": "endpoint_datasets.move", + "namespace": [ + "subpackage_datasets" + ], + "description": "Move the Dataset to a different path or change the name.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Dataset including the Dataset name, which is used as a unique identifier." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Dataset, which is used as a unique identifier." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "datapoints_count": 1, + "directory_id": "directory_id", + "type": "dataset", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "commit_message": "commit_message", + "datapoints": [ + { + "id": "id", + "inputs": { + "key": "value" + }, + "messages": [ + { + "role": "user" + } + ], + "target": { + "key": "value" + } + } + ], + "attributes": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/datasets/id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.move(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.move(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/datasets/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.move(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.move(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.move(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.listDatapoints": { + "id": "endpoint_datasets.listDatapoints", + "namespace": [ + "subpackage_datasets" + ], + "description": "List all Datapoints for the Dataset with the given ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/datapoints" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Dataset to retrieve." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment to retrieve a deployed Version from." + }, + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page number for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Datapoints to fetch." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDatapointResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/ds_b0baF1ca7652/datapoints", + "responseStatusCode": 200, + "name": "List datapoints", + "pathParameters": { + "id": "ds_b0baF1ca7652" + }, + "queryParameters": { + "size": 1 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "dp_901stu", + "messages": [ + { + "role": "user", + "content": "What is the capital of France?" + } + ], + "target": { + "answer": "Paris" + } + }, + { + "id": "dp_234vwx", + "messages": [ + { + "role": "user", + "content": "Who wrote Hamlet?" + } + ], + "target": { + "answer": "William Shakespeare" + } + } + ], + "page": 1, + "size": 10, + "total": 2 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets/ds_b0baF1ca7652/datapoints \\\n -H \"X-API-KEY: \" \\\n -d size=1", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.datasets.list_datapoints(\n id=\"ds_b0baF1ca7652\",\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.listDatapoints(\"ds_b0baF1ca7652\", {\n size: 1\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id/datapoints", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets/:id/datapoints \\\n -H \"X-API-KEY: \" \\\n -d version_id=string \\\n -d environment=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.datasets.list_datapoints(\n id=\"ds_b0baF1ca7652\",\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.listDatapoints(\"ds_b0baF1ca7652\", {\n size: 1\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.listDatapoints(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.listVersions": { + "id": "endpoint_datasets.listVersions", + "namespace": [ + "subpackage_datasets" + ], + "description": "Get a list of the versions for a Dataset.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VersionStatus" + } + }, + "description": "Filter versions by status: 'uncommitted', 'committed'. If no status is provided, all versions are returned." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListDatasets" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/ds_b0baF1ca7652/versions", + "responseStatusCode": 200, + "name": "List versions", + "pathParameters": { + "id": "ds_b0baF1ca7652" + }, + "queryParameters": { + "status": "committed" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets/ds_b0baF1ca7652/versions \\\n -H \"X-API-KEY: \" \\\n -d status=committed", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.list_versions(\n id=\"ds_b0baF1ca7652\",\n status=\"committed\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.listVersions(\"ds_b0baF1ca7652\", {\n status: \"committed\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id/versions", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "status": "uncommitted" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/datasets/:id/versions \\\n -H \"X-API-KEY: \" \\\n -d status=uncommitted", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.list_versions(\n id=\"ds_b0baF1ca7652\",\n status=\"committed\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.listVersions(\"ds_b0baF1ca7652\", {\n status: \"committed\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.listVersions(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "uncommitted": "Humanloop.VersionStatus.Uncommitted", + "committed": "Humanloop.VersionStatus.Committed", + "deleted": "Humanloop.VersionStatus.Deleted" + }, + "templateString": "status: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "status" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.commit": { + "id": "endpoint_datasets.commit", + "namespace": [ + "subpackage_datasets" + ], + "description": "Commit a version of the Dataset with a commit message.\n\nIf the version is already committed, an exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions/" + }, + { + "type": "pathParameter", + "value": "version_id" + }, + { + "type": "literal", + "value": "/commit" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Dataset." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CommitRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/ds_b0baF1ca7652/versions/dsv_6L78pqrdFi2xa/commit", + "responseStatusCode": 200, + "name": "Commit version", + "pathParameters": { + "id": "ds_b0baF1ca7652", + "version_id": "dsv_6L78pqrdFi2xa" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "initial commit" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/datasets/ds_b0baF1ca7652/versions/dsv_6L78pqrdFi2xa/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"initial commit\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.commit(\n id=\"ds_b0baF1ca7652\",\n version_id=\"dsv_6L78pqrdFi2xa\",\n commit_message=\"initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.commit(\"ds_b0baF1ca7652\", \"dsv_6L78pqrdFi2xa\", {\n commitMessage: \"initial commit\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id/versions/:version_id/commit", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "version_id": ":version_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/datasets/:id/versions/:version_id/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.commit(\n id=\"ds_b0baF1ca7652\",\n version_id=\"dsv_6L78pqrdFi2xa\",\n commit_message=\"initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.commit(\"ds_b0baF1ca7652\", \"dsv_6L78pqrdFi2xa\", {\n commitMessage: \"initial commit\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.commit(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "version_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.uploadCsv": { + "id": "endpoint_datasets.uploadCsv", + "namespace": [ + "subpackage_datasets" + ], + "description": "Add Datapoints from a CSV file to a Dataset.\n\nThis will create a new committed version of the Dataset with the Datapoints from the CSV file.\n\nIf either `version_id` or `environment` is provided, the new version will be based on the specified version,\nwith the Datapoints from the CSV file added to the existing Datapoints in the version.\nIf neither `version_id` nor `environment` is provided, the new version will be based on the version\nof the Dataset that is deployed to the default Environment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/datapoints/csv" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Dataset" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the specific Dataset version to base the created Version on." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed Version to base the created Version on." + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "formData", + "fields": [ + { + "type": "file", + "key": "file", + "isOptional": false + }, + { + "type": "property", + "key": "commit_message", + "description": "Commit message for the new Dataset version.", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/id/datapoints/csv", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "form", + "value": { + "file": { + "type": "filename", + "value": "" + }, + "commit_message": { + "type": "json", + "value": "commit_message" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "datapoints_count": 1, + "directory_id": "directory_id", + "type": "dataset", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "commit_message": "commit_message", + "datapoints": [ + { + "id": "id", + "inputs": { + "key": "value" + }, + "messages": [ + { + "role": "user" + } + ], + "target": { + "key": "value" + } + } + ], + "attributes": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/datasets/id/datapoints/csv \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=@ \\\n -F commit_message=\"commit_message\"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.upload_csv(\n id=\"id\",\n commit_message=\"commit_message\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\nimport * as fs from \"fs\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.uploadCsv(fs.createReadStream(\"/path/to/your/file\"), \"id\", {\n commitMessage: \"commit_message\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id/datapoints/csv", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "form", + "value": { + "file": { + "type": "filename", + "value": "" + }, + "commit_message": { + "type": "json", + "value": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/datasets/:id/datapoints/csv?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=@ \\\n -F commit_message=\"string\"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.upload_csv(\n id=\"id\",\n commit_message=\"commit_message\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\nimport * as fs from \"fs\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.uploadCsv(fs.createReadStream(\"/path/to/your/file\"), \"id\", {\n commitMessage: \"commit_message\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.uploadCsv(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [ + "import fs from \"fs\";" + ], + "templateString": "fs.createReadStream('$FERN_INPUT')", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "file" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.setDeployment": { + "id": "endpoint_datasets.setDeployment", + "namespace": [ + "subpackage_datasets" + ], + "description": "Deploy Dataset to Environment.\n\nSet the deployed version for the specified Environment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to deploy the Version to." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Dataset." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/ds_b0baF1ca7652/environments/staging", + "responseStatusCode": 200, + "name": "Deploy", + "pathParameters": { + "id": "ds_b0baF1ca7652", + "environment_id": "staging" + }, + "queryParameters": { + "version_id": "dsv_6L78pqrdFi2xa" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/datasets/ds_b0baF1ca7652/environments/staging?version_id=dsv_6L78pqrdFi2xa\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.set_deployment(\n id=\"ds_b0baF1ca7652\",\n environment_id=\"staging\",\n version_id=\"dsv_6L78pqrdFi2xa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.setDeployment(\"ds_b0baF1ca7652\", \"staging\", {\n versionId: \"dsv_6L78pqrdFi2xa\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": { + "version_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/datasets/:id/environments/:environment_id?version_id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.set_deployment(\n id=\"ds_b0baF1ca7652\",\n environment_id=\"staging\",\n version_id=\"dsv_6L78pqrdFi2xa\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.setDeployment(\"ds_b0baF1ca7652\", \"staging\", {\n versionId: \"dsv_6L78pqrdFi2xa\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.setDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.removeDeployment": { + "id": "endpoint_datasets.removeDeployment", + "namespace": [ + "subpackage_datasets" + ], + "description": "Remove deployed Dataset from Environment.\n\nRemove the deployed version for the specified Environment.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to remove the deployment from." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/ds_b0baF1ca7652/environments/staging", + "responseStatusCode": 204, + "name": "Delete environment", + "pathParameters": { + "id": "ds_b0baF1ca7652", + "environment_id": "staging" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/datasets/ds_b0baF1ca7652/environments/staging \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.remove_deployment(\n id=\"ds_b0baF1ca7652\",\n environment_id=\"staging\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.removeDeployment(\"ds_b0baF1ca7652\", \"staging\");\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/datasets/:id/environments/:environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.remove_deployment(\n id=\"ds_b0baF1ca7652\",\n environment_id=\"staging\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.removeDeployment(\"ds_b0baF1ca7652\", \"staging\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.removeDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_datasets.listEnvironments": { + "id": "endpoint_datasets.listEnvironments", + "namespace": [ + "subpackage_datasets" + ], + "description": "List all Environments and their deployed versions for the Dataset.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Dataset." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileEnvironmentResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/datasets/id/environments", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default", + "file": { + "path": "path", + "id": "id", + "directory_id": "directory_id", + "model": "model", + "endpoint": "complete", + "template": "template", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "other": { + "key": "value" + }, + "seed": 1, + "response_format": { + "type": "json_object" + }, + "tools": [ + { + "name": "name", + "description": "description" + } + ], + "linked_tools": [ + { + "name": "name", + "description": "description", + "id": "id", + "version_id": "version_id" + } + ], + "attributes": { + "key": "value" + }, + "commit_message": "commit_message", + "name": "name", + "version_id": "version_id", + "type": "prompt", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "created_by": { + "id": "id", + "email_address": "email_address" + }, + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ], + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/datasets/id/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.list_environments(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.listEnvironments(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/datasets/:id/environments", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/datasets/:id/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.datasets.list_environments(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.datasets.listEnvironments(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.datasets.listEnvironments(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.list": { + "id": "endpoint_evaluators.list", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Get a list of all Evaluators.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page offset for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Evaluators to fetch." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for Evaluator name." + }, + { + "key": "user_filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for users in the Evaluator. This filter matches against both email address and name of users." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectSortBy" + } + }, + "description": "Field to sort Evaluators by" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortOrder" + } + }, + "description": "Direction to sort by." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataEvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators", + "responseStatusCode": 200, + "name": "List evaluators", + "pathParameters": {}, + "queryParameters": { + "size": 1 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + } + ], + "page": 0, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/evaluators \\\n -H \"X-API-KEY: \" \\\n -d size=1", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.evaluators.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.list({\n size: 1\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/evaluators \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.evaluators.list(\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.list({\n size: 1\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "userFilter: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "user_filter" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "created_at": "Humanloop.ProjectSortBy.CreatedAt", + "updated_at": "Humanloop.ProjectSortBy.UpdatedAt", + "name": "Humanloop.ProjectSortBy.Name" + }, + "templateString": "sortBy: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "sort_by" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "asc": "Humanloop.SortOrder.Asc", + "desc": "Humanloop.SortOrder.Desc" + }, + "templateString": "order: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "order" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.upsert": { + "id": "endpoint_evaluators.upsert", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Create an Evaluator or update it with a new version if it already exists.\n\nEvaluators are identified by the `ID` or their `path`. The spec provided determines the version of the Evaluator.\n\nIf you provide a commit message, then the new version will be committed;\notherwise it will be uncommitted. If you try to commit an already committed version,\nan exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Evaluator, including the name. This locates the Evaluator in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Evaluator." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made." + }, + { + "key": "spec", + "valueShape": { + "type": "id", + "id": "type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators", + "responseStatusCode": 200, + "name": "Create evaluator", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "path": "Shared Evaluators/Accuracy Evaluator", + "commit_message": "Initial commit" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"spec\": {\n \"arguments_type\": \"target_required\",\n \"return_type\": \"number\",\n \"evaluator_type\": \"python\",\n \"code\": \"def evaluate(answer, target):\\n return 0.5\"\n },\n \"path\": \"Shared Evaluators/Accuracy Evaluator\",\n \"commit_message\": \"Initial commit\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.upsert(\n path=\"Shared Evaluators/Accuracy Evaluator\",\n spec={\n \"arguments_type\": \"target_required\",\n \"return_type\": \"number\",\n \"evaluator_type\": \"python\",\n \"code\": \"def evaluate(answer, target):\\n return 0.5\",\n },\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.upsert({\n path: \"Shared Evaluators/Accuracy Evaluator\",\n spec: {\n argumentsType: \"target_required\",\n returnType: \"number\",\n evaluatorType: \"python\",\n code: \"def evaluate(answer, target):\\n return 0.5\"\n },\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"spec\": {\n \"arguments_type\": \"target_free\",\n \"return_type\": \"boolean\",\n \"evaluator_type\": \"llm\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.upsert(\n path=\"Shared Evaluators/Accuracy Evaluator\",\n spec={\n \"arguments_type\": \"target_required\",\n \"return_type\": \"number\",\n \"evaluator_type\": \"python\",\n \"code\": \"def evaluate(answer, target):\\n return 0.5\",\n },\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.upsert({\n path: \"Shared Evaluators/Accuracy Evaluator\",\n spec: {\n argumentsType: \"target_required\",\n returnType: \"number\",\n evaluatorType: \"python\",\n code: \"def evaluate(answer, target):\\n return 0.5\"\n },\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.upsert(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "spec: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "boolean": "Humanloop.EvaluatorReturnTypeEnum.Boolean", + "number": "Humanloop.EvaluatorReturnTypeEnum.Number", + "select": "Humanloop.EvaluatorReturnTypeEnum.Select", + "multi_select": "Humanloop.EvaluatorReturnTypeEnum.MultiSelect", + "text": "Humanloop.EvaluatorReturnTypeEnum.Text" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "Humanloop.ModelEndpoints.Complete", + "chat": "Humanloop.ModelEndpoints.Chat", + "edit": "Humanloop.ModelEndpoints.Edit" + }, + "templateString": "endpoint: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "prompt.endpoint" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "template: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessage" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "prompt.template" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "openai": "Humanloop.ModelProviders.Openai", + "openai_azure": "Humanloop.ModelProviders.OpenaiAzure", + "mock": "Humanloop.ModelProviders.Mock", + "anthropic": "Humanloop.ModelProviders.Anthropic", + "bedrock": "Humanloop.ModelProviders.Bedrock", + "cohere": "Humanloop.ModelProviders.Cohere", + "replicate": "Humanloop.ModelProviders.Replicate", + "google": "Humanloop.ModelProviders.Google", + "groq": "Humanloop.ModelProviders.Groq" + }, + "templateString": "provider: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "prompt.provider" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "stop: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "prompt.stop" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "other: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.other" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "json_object": "Humanloop.ResponseFormatType.JsonObject", + "json_schema": "Humanloop.ResponseFormatType.JsonSchema" + }, + "templateString": "type: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "prompt.response_format.type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "jsonSchema: {\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.response_format.json_schema" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "tools: [\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "parameters" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.tools" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "linkedTools: [\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.linked_tools" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.attributes" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:LlmEvaluatorRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "boolean": "Humanloop.EvaluatorReturnTypeEnum.Boolean", + "number": "Humanloop.EvaluatorReturnTypeEnum.Number", + "select": "Humanloop.EvaluatorReturnTypeEnum.Select", + "multi_select": "Humanloop.EvaluatorReturnTypeEnum.MultiSelect", + "text": "Humanloop.EvaluatorReturnTypeEnum.Text" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "code: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "code" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:CodeEvaluatorRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "select": "Humanloop.HumanEvaluatorRequestReturnType.Select", + "multi_select": "Humanloop.HumanEvaluatorRequestReturnType.MultiSelect", + "text": "Humanloop.HumanEvaluatorRequestReturnType.Text", + "number": "Humanloop.HumanEvaluatorRequestReturnType.Number", + "boolean": "Humanloop.HumanEvaluatorRequestReturnType.Boolean" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "instructions: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "instructions" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "options: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "positive": "Humanloop.Valence.Positive", + "negative": "Humanloop.Valence.Negative", + "neutral": "Humanloop.Valence.Neutral" + }, + "templateString": "valence: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "valence" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "options" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numberLimits: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "min: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "number_limits.min" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "max: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "number_limits.max" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "step: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "number_limits.step" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "positive": "Humanloop.Valence.Positive", + "negative": "Humanloop.Valence.Negative", + "neutral": "Humanloop.Valence.Neutral" + }, + "templateString": "numberValence: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "number_valence" + } + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:HumanEvaluatorRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "boolean": "Humanloop.EvaluatorReturnTypeEnum.Boolean", + "number": "Humanloop.EvaluatorReturnTypeEnum.Number", + "select": "Humanloop.EvaluatorReturnTypeEnum.Select", + "multi_select": "Humanloop.EvaluatorReturnTypeEnum.MultiSelect", + "text": "Humanloop.EvaluatorReturnTypeEnum.Text" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ExternalEvaluatorRequest" + } + } + ], + "templateInput": { + "location": "BODY", + "path": "spec" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.get": { + "id": "endpoint_evaluators.get", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Retrieve the Evaluator with the given ID.\n\nBy default, the deployed version of the Evaluator is returned. Use the query parameters\n`version_id` or `environment` to target a specific version of the Evaluator.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluator." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Evaluator to retrieve." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment to retrieve a deployed Version from." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd", + "responseStatusCode": 200, + "name": "Get specific evaluator", + "pathParameters": { + "id": "ev_890bcd" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluators/ev_890bcd \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.get(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.get(\"ev_890bcd\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/evaluators/:id \\\n -H \"X-API-KEY: \" \\\n -d version_id=string \\\n -d environment=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.get(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.get(\"ev_890bcd\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.delete": { + "id": "endpoint_evaluators.delete", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Delete the Evaluator with the given ID.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluator." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd", + "responseStatusCode": 204, + "name": "Delete evaluator", + "pathParameters": { + "id": "ev_890bcd" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/evaluators/ev_890bcd \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.delete(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.delete(\"ev_890bcd\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/evaluators/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.delete(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.delete(\"ev_890bcd\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.move": { + "id": "endpoint_evaluators.move", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Move the Evaluator to a different path or change the name.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluator." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Evaluator including the Evaluator name, which is used as a unique identifier." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Evaluator, which is used as a unique identifier." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd", + "responseStatusCode": 200, + "name": "Move evaluator", + "pathParameters": { + "id": "ev_890bcd" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "path": "new directory/new name" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/evaluators/ev_890bcd \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"path\": \"new directory/new name\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.move(\n id=\"ev_890bcd\",\n path=\"new directory/new name\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.move(\"ev_890bcd\", {\n path: \"new directory/new name\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/evaluators/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.move(\n id=\"ev_890bcd\",\n path=\"new directory/new name\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.move(\"ev_890bcd\", {\n path: \"new directory/new name\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.move(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.listVersions": { + "id": "endpoint_evaluators.listVersions", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Get a list of all the versions of an Evaluator.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator." + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VersionStatus" + } + }, + "description": "Filter versions by status: 'uncommitted', 'committed'. If no status is provided, all versions are returned." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to include Evaluator aggregate results for the versions in the response" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListEvaluators" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd/versions", + "responseStatusCode": 200, + "name": "List versions", + "pathParameters": { + "id": "ev_890bcd" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluators/ev_890bcd/versions \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.list_versions(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.listVersions(\"ev_890bcd\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id/versions", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "status": "uncommitted", + "evaluator_aggregates": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/evaluators/:id/versions \\\n -H \"X-API-KEY: \" \\\n -d status=uncommitted \\\n -d evaluator_aggregates=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.list_versions(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.listVersions(\"ev_890bcd\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.listVersions(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "uncommitted": "Humanloop.VersionStatus.Uncommitted", + "committed": "Humanloop.VersionStatus.Committed", + "deleted": "Humanloop.VersionStatus.Deleted" + }, + "templateString": "status: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "status" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorAggregates: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "evaluator_aggregates" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.commit": { + "id": "endpoint_evaluators.commit", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Commit a version of the Evaluator with a commit message.\n\nIf the version is already committed, an exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions/" + }, + { + "type": "pathParameter", + "value": "version_id" + }, + { + "type": "literal", + "value": "/commit" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Prompt." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Evaluator." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CommitRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd/versions/evv_012def/commit", + "responseStatusCode": 200, + "name": "Commit version", + "pathParameters": { + "id": "ev_890bcd", + "version_id": "evv_012def" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "Initial commit" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/evaluators/ev_890bcd/versions/evv_012def/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"Initial commit\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.commit(\n id=\"ev_890bcd\",\n version_id=\"evv_012def\",\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.commit(\"ev_890bcd\", \"evv_012def\", {\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id/versions/:version_id/commit", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "version_id": ":version_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/evaluators/:id/versions/:version_id/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.commit(\n id=\"ev_890bcd\",\n version_id=\"evv_012def\",\n commit_message=\"Initial commit\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.commit(\"ev_890bcd\", \"evv_012def\", {\n commitMessage: \"Initial commit\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.commit(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "version_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.setDeployment": { + "id": "endpoint_evaluators.setDeployment", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Deploy Evaluator to an Environment.\n\nSet the deployed version for the specified Environment. This Evaluator\nwill be used for calls made to the Evaluator in this Environment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluator." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to deploy the Version to." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Evaluator." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd/environments/staging", + "responseStatusCode": 200, + "name": "Deploy", + "pathParameters": { + "id": "ev_890bcd", + "environment_id": "staging" + }, + "queryParameters": { + "version_id": "evv_012def" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/evaluators/ev_890bcd/environments/staging?version_id=evv_012def\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.set_deployment(\n id=\"ev_890bcd\",\n environment_id=\"staging\",\n version_id=\"evv_012def\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.setDeployment(\"ev_890bcd\", \"staging\", {\n versionId: \"evv_012def\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": { + "version_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/evaluators/:id/environments/:environment_id?version_id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.set_deployment(\n id=\"ev_890bcd\",\n environment_id=\"staging\",\n version_id=\"evv_012def\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.setDeployment(\"ev_890bcd\", \"staging\", {\n versionId: \"evv_012def\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.setDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.removeDeployment": { + "id": "endpoint_evaluators.removeDeployment", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Remove deployed Evaluator from the Environment.\n\nRemove the deployed version for the specified Environment. This Evaluator\nwill no longer be used for calls made to the Evaluator in this Environment.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluator." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to remove the deployment from." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd/environments/staging", + "responseStatusCode": 204, + "name": "Delete environment", + "pathParameters": { + "id": "ev_890bcd", + "environment_id": "staging" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/evaluators/ev_890bcd/environments/staging \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.remove_deployment(\n id=\"ev_890bcd\",\n environment_id=\"staging\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.removeDeployment(\"ev_890bcd\", \"staging\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/evaluators/:id/environments/:environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.remove_deployment(\n id=\"ev_890bcd\",\n environment_id=\"staging\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.removeDeployment(\"ev_890bcd\", \"staging\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.removeDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.listEnvironments": { + "id": "endpoint_evaluators.listEnvironments", + "namespace": [ + "subpackage_evaluators" + ], + "description": "List all Environments and their deployed versions for the Evaluator.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluators/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluator." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileEnvironmentResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/ev_890bcd/environments", + "responseStatusCode": 200, + "name": "List environments", + "pathParameters": { + "id": "ev_890bcd" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "env_abc123", + "created_at": "2024-05-01T12:00:00Z", + "name": "production", + "tag": "default", + "file": { + "id": "ev_890bcd", + "name": "Accuracy Evaluator", + "path": "Shared Evaluators/Accuracy Evaluator", + "version_id": "evv_012def", + "type": "evaluator", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ] + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluators/ev_890bcd/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.list_environments(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.listEnvironments(\"ev_890bcd\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/:id/environments", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluators/:id/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.list_environments(\n id=\"ev_890bcd\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.listEnvironments(\"ev_890bcd\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.listEnvironments(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluators.log": { + "id": "endpoint_evaluators.log", + "namespace": [ + "subpackage_evaluators" + ], + "description": "Submit Evaluator judgment for an existing Log.\n\nCreates a new Log. The evaluated Log will be set as the parent of the created Log.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluators/log" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the Evaluator version to log against." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed version to log to." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Evaluator, including the name. This locates the Evaluator in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Evaluator." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from the LLM. Only populated for LLM Evaluator Logs." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created. " + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider. Only populated for LLM Evaluator Logs." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider. Only populated for LLM Evaluator Logs." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "parent_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier of the evaluated Log. The newly created Log will have this one set as parent." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "judgment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_evaluators:CreateEvaluatorLogRequestJudgment" + } + }, + "description": "Evaluator assessment of the Log." + }, + { + "key": "spec", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_evaluators:CreateEvaluatorLogRequestSpec" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateEvaluatorLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluators/log", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "parent_id": "parent_id" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "parent_id": "parent_id", + "version_id": "version_id", + "session_id": "session_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/evaluators/log \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"parent_id\": \"parent_id\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.log(\n parent_id=\"parent_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.log({\n parentId: \"parent_id\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluators/log", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "parent_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/evaluators/log?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"parent_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluators.log(\n parent_id=\"parent_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluators.log({\n parentId: \"parent_id\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluators.log(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "output: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "createdAt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "created_at" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "error: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "error" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerLatency: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_latency" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "stdout: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stdout" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerRequest: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_request" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerResponse: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_response" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "parentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "parent_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceDatapointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source_datapoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "traceParentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "trace_parent_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "batches: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "batches" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "createEvaluatorLogRequestEnvironment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "save: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "save" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "judgment: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + ], + "templateInput": { + "location": "BODY", + "path": "judgment" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "spec: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "boolean": "Humanloop.EvaluatorReturnTypeEnum.Boolean", + "number": "Humanloop.EvaluatorReturnTypeEnum.Number", + "select": "Humanloop.EvaluatorReturnTypeEnum.Select", + "multi_select": "Humanloop.EvaluatorReturnTypeEnum.MultiSelect", + "text": "Humanloop.EvaluatorReturnTypeEnum.Text" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "Humanloop.ModelEndpoints.Complete", + "chat": "Humanloop.ModelEndpoints.Chat", + "edit": "Humanloop.ModelEndpoints.Edit" + }, + "templateString": "endpoint: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "prompt.endpoint" + } + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "template: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "content: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessageContentItem" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "content" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "toolCallId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "tool_call_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "user": "Humanloop.ChatRole.User", + "assistant": "Humanloop.ChatRole.Assistant", + "system": "Humanloop.ChatRole.System", + "tool": "Humanloop.ChatRole.Tool" + }, + "templateString": "role: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "role" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "toolCalls: [\n\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "function: {\n\t\t\t\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t\t\t\t\t", + "templateInputs": [] + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "tool_calls" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "id", + "value": "type_:ChatMessage" + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "prompt.template" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "openai": "Humanloop.ModelProviders.Openai", + "openai_azure": "Humanloop.ModelProviders.OpenaiAzure", + "mock": "Humanloop.ModelProviders.Mock", + "anthropic": "Humanloop.ModelProviders.Anthropic", + "bedrock": "Humanloop.ModelProviders.Bedrock", + "cohere": "Humanloop.ModelProviders.Cohere", + "replicate": "Humanloop.ModelProviders.Replicate", + "google": "Humanloop.ModelProviders.Google", + "groq": "Humanloop.ModelProviders.Groq" + }, + "templateString": "provider: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "prompt.provider" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "stop: $FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "type": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "template": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "type": { + "type": "list", + "itemType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": "prompt.stop" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "other: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.other" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "prompt.seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "json_object": "Humanloop.ResponseFormatType.JsonObject", + "json_schema": "Humanloop.ResponseFormatType.JsonSchema" + }, + "templateString": "type: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "prompt.response_format.type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "jsonSchema: {\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.response_format.json_schema" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "tools: [\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strict: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "strict" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "parameters: {\n\t\t\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "parameters" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.tools" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "linkedTools: [\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.linked_tools" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "prompt.attributes" + } + } + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:LlmEvaluatorRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "boolean": "Humanloop.EvaluatorReturnTypeEnum.Boolean", + "number": "Humanloop.EvaluatorReturnTypeEnum.Number", + "select": "Humanloop.EvaluatorReturnTypeEnum.Select", + "multi_select": "Humanloop.EvaluatorReturnTypeEnum.MultiSelect", + "text": "Humanloop.EvaluatorReturnTypeEnum.Text" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "code: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "code" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:CodeEvaluatorRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "select": "Humanloop.HumanEvaluatorRequestReturnType.Select", + "multi_select": "Humanloop.HumanEvaluatorRequestReturnType.MultiSelect", + "text": "Humanloop.HumanEvaluatorRequestReturnType.Text", + "number": "Humanloop.HumanEvaluatorRequestReturnType.Number", + "boolean": "Humanloop.HumanEvaluatorRequestReturnType.Boolean" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "instructions: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "instructions" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "options: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "positive": "Humanloop.Valence.Positive", + "negative": "Humanloop.Valence.Negative", + "neutral": "Humanloop.Valence.Neutral" + }, + "templateString": "valence: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "valence" + } + } + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "options" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numberLimits: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "min: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "number_limits.min" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "max: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "number_limits.max" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "step: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "number_limits.step" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "positive": "Humanloop.Valence.Positive", + "negative": "Humanloop.Valence.Negative", + "neutral": "Humanloop.Valence.Neutral" + }, + "templateString": "numberValence: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "number_valence" + } + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:HumanEvaluatorRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "target_free": "Humanloop.EvaluatorArgumentsType.TargetFree", + "target_required": "Humanloop.EvaluatorArgumentsType.TargetRequired" + }, + "templateString": "argumentsType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "arguments_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "boolean": "Humanloop.EvaluatorReturnTypeEnum.Boolean", + "number": "Humanloop.EvaluatorReturnTypeEnum.Number", + "select": "Humanloop.EvaluatorReturnTypeEnum.Select", + "multi_select": "Humanloop.EvaluatorReturnTypeEnum.MultiSelect", + "text": "Humanloop.EvaluatorReturnTypeEnum.Text" + }, + "templateString": "returnType: $FERN_INPUT", + "templateInput": { + "location": "RELATIVE", + "path": "return_type" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "delimiter": ",\n\t\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": "attributes" + } + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:ExternalEvaluatorRequest" + } + } + ], + "templateInput": { + "location": "BODY", + "path": "spec" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.get": { + "id": "endpoint_flows.get", + "namespace": [ + "subpackage_flows" + ], + "description": "Retrieve the Flow with the given ID.\n\nBy default, the deployed version of the Flow is returned. Use the query parameters\n`version_id` or `environment` to target a specific version of the Flow.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Flow to retrieve." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment to retrieve a deployed Version from." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "version": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/flows/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.get(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.get(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/flows/:id \\\n -H \"X-API-KEY: \" \\\n -d version_id=string \\\n -d environment=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.get(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.get(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.delete": { + "id": "endpoint_flows.delete", + "namespace": [ + "subpackage_flows" + ], + "description": "Delete the Flow with the given ID.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/flows/id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.delete(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.delete(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/flows/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.delete(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.delete(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.move": { + "id": "endpoint_flows.move", + "namespace": [ + "subpackage_flows" + ], + "description": "Move the Flow to a different path or change the name.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Flow including the Flow name, which is used as a unique identifier." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Flow." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Directory to move Flow to. Starts with `dir_`." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "version": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/flows/id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.move(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.move(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/flows/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.move(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.move(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.move(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "directoryId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "directory_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.list": { + "id": "endpoint_flows.list", + "namespace": [ + "subpackage_flows" + ], + "description": "Get a list of Flows.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/flows" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page number for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Flows to fetch." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for Flow name." + }, + { + "key": "user_filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for users in the Flow. This filter matches against both email address and name of users." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectSortBy" + } + }, + "description": "Field to sort Flows by" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortOrder" + } + }, + "description": "Direction to sort by." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataFlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/flows \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.list();\n", + "generated": true + } + ] + } + }, + { + "path": "/flows", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/flows \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.list();\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "userFilter: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "user_filter" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "created_at": "Humanloop.ProjectSortBy.CreatedAt", + "updated_at": "Humanloop.ProjectSortBy.UpdatedAt", + "name": "Humanloop.ProjectSortBy.Name" + }, + "templateString": "sortBy: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "sort_by" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "asc": "Humanloop.SortOrder.Asc", + "desc": "Humanloop.SortOrder.Desc" + }, + "templateString": "order: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "order" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.upsert": { + "id": "endpoint_flows.upsert", + "namespace": [ + "subpackage_flows" + ], + "description": "Create or update a Flow.\n\nFlows can also be identified by the `ID` or their `path`.\n\nIf you provide a commit message, then the new version will be committed;\notherwise it will be uncommitted. If you try to commit an already committed version,\nan exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/flows" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Flow, including the name. This locates the Flow in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Flow." + }, + { + "key": "attributes", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + }, + "description": "A key-value object identifying the Flow Version." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "attributes": { + "key": "value" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "version": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/flows \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"attributes\": {\n \"key\": \"value\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.upsert(\n attributes={\"key\": \"value\"},\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.upsert({\n attributes: {\n \"key\": \"value\"\n }\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/flows", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "attributes": { + "string": {} + } + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/flows \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"attributes\": {\n \"string\": {}\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.upsert(\n attributes={\"key\": \"value\"},\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.upsert({\n attributes: {\n \"key\": \"value\"\n }\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.upsert(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "attributes" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.log": { + "id": "endpoint_flows.log", + "namespace": [ + "subpackage_flows" + ], + "description": "Log to a Flow.\n\nYou can use query parameters `version_id`, or `environment`, to target\nan existing version of the Flow. Otherwise, the default deployed version will be chosen.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/flows/log" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A specific Version ID of the Flow to log to." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment identifying a deployed version to log to." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluation_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Evaluation Report to associate the Log to." + }, + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the Flow, including the name. This locates the Flow in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing Flow." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The start time of the Trace. Will be updated if a child Log with an earlier start time is added." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The end time of the Trace. Will be updated if a child Log with a later end time is added." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created. " + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "trace_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the Trace. If not provided, one will be assigned." + }, + { + "key": "flow", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FlowKernelRequest" + } + }, + "description": "Flow used to generate the Trace." + }, + { + "key": "trace_status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TraceStatus" + } + }, + "description": "Status of the Trace. When a Trace is marked as `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on `complete` Traces. If you do not intend to add more Logs to the Trace after creation, set this to `complete`." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateFlowLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/log", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "flow_id": "flow_id", + "version_id": "version_id", + "trace_status": "complete" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/flows/log \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.log()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.log();\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/log", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "version_id": "string", + "environment": "string" + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/flows/log?version_id=string&environment=string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.log()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.log();\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.log(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluationId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "evaluation_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "start_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endTime: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "end_time" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "output: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "createdAt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "created_at" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "error: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "error" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "providerLatency: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "provider_latency" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "stdout: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stdout" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerRequest: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_request" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "providerResponse: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "provider_response" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "source: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "metadata: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "metadata" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "sourceDatapointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "source_datapoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "traceParentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "trace_parent_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "batches: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "batches" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "flowLogRequestEnvironment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "save: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "save" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "traceId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "trace_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "flow: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "attributes: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "flow.attributes" + } + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "Humanloop.TraceStatus.Complete", + "incomplete": "Humanloop.TraceStatus.Incomplete" + }, + "templateString": "traceStatus: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "trace_status" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.updateLog": { + "id": "endpoint_flows.updateLog", + "namespace": [ + "subpackage_flows" + ], + "description": "Update the status, inputs, output of a Flow Log.\n\nMarking a Flow Log as complete will trigger any monitoring Evaluators to run.\nInputs and output (or error) must be provided in order to mark it as complete.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/flows/logs/" + }, + { + "type": "pathParameter", + "value": "log_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "log_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of the Flow Log." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the Flow Log." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The output of the Flow Log. Provide None to unset existing `output` value. Provide either this or `error`." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The error message of the Flow Log. Provide None to unset existing `error` value. Provide either this or `output`." + }, + { + "key": "trace_status", + "valueShape": { + "type": "id", + "id": "type_:TraceStatus" + }, + "description": "Status of the Trace. When a Trace is marked as `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on completed Traces." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FlowLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/logs/log_id", + "responseStatusCode": 200, + "pathParameters": { + "log_id": "log_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "trace_status": "complete" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "evaluator_logs": [ + { + "id": "id", + "evaluator_logs": [], + "evaluator": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "start_time": "2024-01-15T09:30:00Z", + "end_time": "2024-01-15T09:30:00Z", + "output": "output", + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "provider_latency": 1.1, + "stdout": "stdout", + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "parent_id": "parent_id", + "source_datapoint_id": "source_datapoint_id", + "trace_parent_id": "trace_parent_id", + "batches": [ + "batches" + ], + "user": "user", + "environment": "environment", + "save": true, + "judgment": true, + "trace_flow_id": "trace_flow_id", + "trace_id": "trace_id", + "trace_children": [ + { + "prompt": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "id": "id", + "evaluator_logs": [] + } + ], + "parent": { + "prompt": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "id": "id", + "evaluator_logs": [] + } + } + ], + "flow": { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + }, + "start_time": "2024-01-15T09:30:00Z", + "end_time": "2024-01-15T09:30:00Z", + "output": "output", + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "provider_latency": 1.1, + "stdout": "stdout", + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "source_datapoint_id": "source_datapoint_id", + "trace_parent_id": "trace_parent_id", + "batches": [ + "batches" + ], + "user": "user", + "environment": "environment", + "save": true, + "trace_flow_id": "trace_flow_id", + "trace_id": "trace_id", + "trace_children": [ + { + "output_message": { + "role": "user" + }, + "prompt_tokens": 1, + "output_tokens": 1, + "prompt_cost": 1.1, + "output_cost": 1.1, + "finish_reason": "finish_reason", + "messages": [ + { + "role": "user" + } + ], + "tool_choice": "none", + "prompt": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "start_time": "2024-01-15T09:30:00Z", + "end_time": "2024-01-15T09:30:00Z", + "output": "output", + "created_at": "2024-01-15T09:30:00Z", + "error": "error", + "provider_latency": 1.1, + "stdout": "stdout", + "provider_request": { + "key": "value" + }, + "provider_response": { + "key": "value" + }, + "inputs": { + "key": "value" + }, + "source": "source", + "metadata": { + "key": "value" + }, + "source_datapoint_id": "source_datapoint_id", + "trace_parent_id": "trace_parent_id", + "batches": [ + "batches" + ], + "user": "user", + "environment": "environment", + "save": true, + "id": "id", + "evaluator_logs": [ + { + "id": "id", + "evaluator_logs": [], + "evaluator": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ], + "trace_flow_id": "trace_flow_id", + "trace_id": "trace_id" + } + ], + "trace_status": "complete" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/flows/logs/log_id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"trace_status\": \"complete\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.update_log(\n log_id=\"log_id\",\n trace_status=\"complete\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.updateLog(\"log_id\", {\n traceStatus: \"complete\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/logs/:log_id", + "responseStatusCode": 422, + "pathParameters": { + "log_id": ":log_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "trace_status": "complete" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/flows/logs/:log_id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"trace_status\": \"complete\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.update_log(\n log_id=\"log_id\",\n trace_status=\"complete\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.updateLog(\"log_id\", {\n traceStatus: \"complete\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.updateLog(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "log_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "inputs: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "inputs" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "output: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "output" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "error: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "error" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "complete": "Humanloop.TraceStatus.Complete", + "incomplete": "Humanloop.TraceStatus.Incomplete" + }, + "templateString": "traceStatus: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "trace_status" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.listVersions": { + "id": "endpoint_flows.listVersions", + "namespace": [ + "subpackage_flows" + ], + "description": "Get a list of all the versions of a Flow.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VersionStatus" + } + }, + "description": "Filter versions by status: 'uncommitted', 'committed'. If no status is provided, all versions are returned." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to include Evaluator aggregate results for the versions in the response" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListFlows" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id/versions", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/flows/id/versions \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.list_versions(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.listVersions(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id/versions", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "status": "uncommitted", + "evaluator_aggregates": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/flows/:id/versions \\\n -H \"X-API-KEY: \" \\\n -d status=uncommitted \\\n -d evaluator_aggregates=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.list_versions(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.listVersions(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.listVersions(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "uncommitted": "Humanloop.VersionStatus.Uncommitted", + "committed": "Humanloop.VersionStatus.Committed", + "deleted": "Humanloop.VersionStatus.Deleted" + }, + "templateString": "status: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "status" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorAggregates: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "evaluator_aggregates" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.commit": { + "id": "endpoint_flows.commit", + "namespace": [ + "subpackage_flows" + ], + "description": "Commit a version of the Flow with a commit message.\n\nIf the version is already committed, an exception will be raised.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions/" + }, + { + "type": "pathParameter", + "value": "version_id" + }, + { + "type": "literal", + "value": "/commit" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Flow." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CommitRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id/versions/version_id/commit", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "version_id": "version_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "commit_message" + } + }, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "version": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/flows/id/versions/version_id/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"commit_message\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.commit(\n id=\"id\",\n version_id=\"version_id\",\n commit_message=\"commit_message\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.commit(\"id\", \"version_id\", {\n commitMessage: \"commit_message\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id/versions/:version_id/commit", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "version_id": ":version_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "commit_message": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/flows/:id/versions/:version_id/commit \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"commit_message\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.commit(\n id=\"id\",\n version_id=\"version_id\",\n commit_message=\"commit_message\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.commit(\"id\", \"version_id\", {\n commitMessage: \"commit_message\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.commit(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "version_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "commitMessage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "commit_message" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.setDeployment": { + "id": "endpoint_flows.setDeployment", + "namespace": [ + "subpackage_flows" + ], + "description": "Deploy Flow to an Environment.\n\nSet the deployed version for the specified Environment. This Flow\nwill be used for calls made to the Flow in this Environment.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to deploy the Version to." + } + ], + "queryParameters": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific version of the Flow." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id/environments/environment_id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "environment_id": "environment_id" + }, + "queryParameters": { + "version_id": "version_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "version": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/flows/id/environments/environment_id?version_id=version_id\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.set_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n version_id=\"version_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.setDeployment(\"id\", \"environment_id\", {\n versionId: \"version_id\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": { + "version_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://api.humanloop.com/v5/flows/:id/environments/:environment_id?version_id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.set_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n version_id=\"version_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.setDeployment(\"id\", \"environment_id\", {\n versionId: \"version_id\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.setDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.removeDeployment": { + "id": "endpoint_flows.removeDeployment", + "namespace": [ + "subpackage_flows" + ], + "description": "Remove deployed Flow from the Environment.\n\nRemove the deployed version for the specified Environment. This Flow\nwill no longer be used for calls made to the Flow in this Environment.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments/" + }, + { + "type": "pathParameter", + "value": "environment_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment to remove the deployment from." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id/environments/environment_id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id", + "environment_id": "environment_id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/flows/id/environments/environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.remove_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.removeDeployment(\"id\", \"environment_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id/environments/:environment_id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "environment_id": ":environment_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/flows/:id/environments/:environment_id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.remove_deployment(\n id=\"id\",\n environment_id=\"environment_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.removeDeployment(\"id\", \"environment_id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.removeDeployment(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "environment_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.listEnvironments": { + "id": "endpoint_flows.listEnvironments", + "namespace": [ + "subpackage_flows" + ], + "description": "List all Environments and their deployed versions for the Flow.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/environments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Flow." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileEnvironmentResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id/environments", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default", + "file": { + "path": "path", + "id": "id", + "directory_id": "directory_id", + "model": "model", + "endpoint": "complete", + "template": "template", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "other": { + "key": "value" + }, + "seed": 1, + "response_format": { + "type": "json_object" + }, + "tools": [ + { + "name": "name", + "description": "description" + } + ], + "linked_tools": [ + { + "name": "name", + "description": "description", + "id": "id", + "version_id": "version_id" + } + ], + "attributes": { + "key": "value" + }, + "commit_message": "commit_message", + "name": "name", + "version_id": "version_id", + "type": "prompt", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "created_by": { + "id": "id", + "email_address": "email_address" + }, + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ], + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/flows/id/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.list_environments(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.listEnvironments(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id/environments", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/flows/:id/environments \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.list_environments(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.listEnvironments(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.listEnvironments(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_flows.updateMonitoring": { + "id": "endpoint_flows.updateMonitoring", + "namespace": [ + "subpackage_flows" + ], + "description": "Activate and deactivate Evaluators for monitoring the Flow.\n\nAn activated Evaluator will automatically be run on all new \"completed\" Logs\nwithin the Flow for monitoring purposes.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/flows/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/evaluators" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluatorActivationDeactivationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/flows/id/evaluators", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "path": "path", + "id": "id", + "attributes": { + "key": "value" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "directory_id": "directory_id", + "commit_message": "commit_message", + "type": "flow", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "evaluators": [ + { + "version_reference": { + "file": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "environment": { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + }, + "type": "environment" + }, + "state": "active", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "version": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/flows/id/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.update_monitoring(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient, Humanloop } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.updateMonitoring(\"id\", {});\n", + "generated": true + } + ] + } + }, + { + "path": "/flows/:id/evaluators", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/flows/:id/evaluators \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.flows.update_monitoring(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient, Humanloop } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.flows.updateMonitoring(\"id\", {});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.flows.updateMonitoring(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "activate: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorVersionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_version_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environmentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "activate" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "deactivate: [\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "type": "union_v2", + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "members": [ + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorVersionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_version_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "template": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "evaluatorId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "evaluator_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environmentId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment_id" + } + ] + } + } + ] + }, + "type": { + "type": "id", + "value": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ], + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "deactivate" + } + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_files.list": { + "id": "endpoint_files.list", + "namespace": [ + "subpackage_files" + ], + "description": "Get a paginated list of files.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/files" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page offset for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of files to fetch." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-insensitive filter for file name." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FileType" + } + }, + "description": "List of file types to filter for." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Case-sensitive filter for files with a deployment in the specified environment. Requires the environment name." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProjectSortBy" + } + }, + "description": "Field to sort files by" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortOrder" + } + }, + "description": "Direction to sort by." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/files", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "path": "path", + "id": "id", + "directory_id": "directory_id", + "model": "model", + "endpoint": "complete", + "template": "template", + "provider": "openai", + "max_tokens": 1, + "temperature": 1.1, + "top_p": 1.1, + "stop": "stop", + "presence_penalty": 1.1, + "frequency_penalty": 1.1, + "other": { + "key": "value" + }, + "seed": 1, + "response_format": { + "type": "json_object" + }, + "tools": [ + { + "name": "name", + "description": "description" + } + ], + "linked_tools": [ + { + "name": "name", + "description": "description", + "id": "id", + "version_id": "version_id" + } + ], + "attributes": { + "key": "value" + }, + "commit_message": "commit_message", + "name": "name", + "version_id": "version_id", + "type": "prompt", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "created_by": { + "id": "id", + "email_address": "email_address" + }, + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ], + "evaluator_aggregates": [ + { + "value": 1.1, + "evaluator_id": "evaluator_id", + "evaluator_version_id": "evaluator_version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ] + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/files \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.files.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.files.list();\n", + "generated": true + } + ] + } + }, + { + "path": "/files", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/files \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.files.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.files.list();\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.files.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "prompt": "Humanloop.FileType.Prompt", + "tool": "Humanloop.FileType.Tool", + "dataset": "Humanloop.FileType.Dataset", + "evaluator": "Humanloop.FileType.Evaluator", + "flow": "Humanloop.FileType.Flow" + }, + "templateString": "type: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "type" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "created_at": "Humanloop.ProjectSortBy.CreatedAt", + "updated_at": "Humanloop.ProjectSortBy.UpdatedAt", + "name": "Humanloop.ProjectSortBy.Name" + }, + "templateString": "sortBy: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "sort_by" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "asc": "Humanloop.SortOrder.Asc", + "desc": "Humanloop.SortOrder.Desc" + }, + "templateString": "order: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "order" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.list": { + "id": "endpoint_evaluations.list", + "namespace": [ + "subpackage_evaluations" + ], + "description": "List all Evaluations for the specified `file_id`.\n\nRetrieve a list of Evaluations that evaluate versions of the specified File.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "file_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Filter by File ID. Only Evaluations for the specified File will be returned." + }, + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page number for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Evaluations to fetch." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedEvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations", + "responseStatusCode": 200, + "name": "List evaluations for file", + "pathParameters": {}, + "queryParameters": { + "file_id": "pr_30gco7dx6JDq4200GVOHa", + "size": 1 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "ev_567yza", + "dataset": { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + }, + "evaluatees": [ + { + "version": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + }, + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "model": "gpt-4o", + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ] + }, + "orchestrated": false + } + ], + "evaluators": [ + { + "version": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + }, + "orchestrated": false + } + ], + "status": "completed", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z" + } + ], + "page": 1, + "size": 10, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/evaluations \\\n -H \"X-API-KEY: \" \\\n -d file_id=pr_30gco7dx6JDq4200GVOHa \\\n -d size=1", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.evaluations.list(\n file_id=\"pr_30gco7dx6JDq4200GVOHa\",\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.list({\n fileId: \"pr_30gco7dx6JDq4200GVOHa\",\n size: 1\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "file_id": "string", + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/evaluations \\\n -H \"X-API-KEY: \" \\\n -d file_id=string \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.evaluations.list(\n file_id=\"pr_30gco7dx6JDq4200GVOHa\",\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.list({\n fileId: \"pr_30gco7dx6JDq4200GVOHa\",\n size: 1\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.create": { + "id": "endpoint_evaluations.create", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Create an Evaluation.\n\nCreate a new Evaluation by specifying the Dataset, versions to be\nevaluated (Evaluatees), and which Evaluators to provide judgments.\n\nHumanloop will automatically start generating Logs and running Evaluators where\n`orchestrated=true`. If you own the runtime for the Evaluatee or Evaluator, you\ncan set `orchestrated=false` and then generate and submit the required logs using\nyour runtime.\n\nTo keep updated on the progress of the Evaluation, you can poll the Evaluation using\nthe GET /evaluations/{id} endpoint and check its status.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/evaluations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "dataset", + "valueShape": { + "type": "id", + "id": "type_:EvaluationsDatasetRequest" + }, + "description": "Dataset to use in this Evaluation." + }, + { + "key": "evaluatees", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluateeRequest" + } + } + }, + "description": "Unique identifiers for the Prompt/Tool Versions to include in the Evaluation. Can be left unpopulated if you wish to add Evaluatees to this Evaluation by specifying `evaluation_id` in Log calls." + }, + { + "key": "evaluators", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationsRequest" + } + }, + "description": "The Evaluators used to evaluate." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Evaluation to help identify it. Must be unique within the associated File." + }, + { + "key": "file", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FileRequest" + } + }, + "description": "The File to associate with the Evaluation." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations", + "responseStatusCode": 200, + "name": "Create evaluation", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "dataset": { + "version_id": "dsv_6L78pqrdFi2xa" + }, + "evaluators": [ + { + "version_id": "evv_012def", + "orchestrated": false + } + ], + "evaluatees": [ + { + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "orchestrated": false + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "ev_567yza", + "dataset": { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + }, + "evaluatees": [ + { + "version": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + }, + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "model": "gpt-4o", + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ] + }, + "orchestrated": false + } + ], + "evaluators": [ + { + "version": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + }, + "orchestrated": false + } + ], + "status": "completed", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/evaluations \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"dataset\": {\n \"version_id\": \"dsv_6L78pqrdFi2xa\"\n },\n \"evaluators\": [\n {\n \"version_id\": \"evv_012def\",\n \"orchestrated\": false\n }\n ],\n \"evaluatees\": [\n {\n \"version_id\": \"prv_7ZlQREDScH0xkhUwtXruN\",\n \"orchestrated\": false\n }\n ]\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.create(\n dataset={\"version_id\": \"dsv_6L78pqrdFi2xa\"},\n evaluatees=[\n {\"version_id\": \"prv_7ZlQREDScH0xkhUwtXruN\", \"orchestrated\": False}\n ],\n evaluators=[{\"version_id\": \"evv_012def\", \"orchestrated\": False}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.create({\n dataset: {\n versionId: \"dsv_6L78pqrdFi2xa\"\n },\n evaluatees: [{\n versionId: \"prv_7ZlQREDScH0xkhUwtXruN\",\n orchestrated: false\n }],\n evaluators: [{\n versionId: \"evv_012def\",\n orchestrated: false\n }]\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "dataset": {}, + "evaluators": [ + {} + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.humanloop.com/v5/evaluations \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"dataset\": {},\n \"evaluators\": [\n {}\n ]\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.create(\n dataset={\"version_id\": \"dsv_6L78pqrdFi2xa\"},\n evaluatees=[\n {\"version_id\": \"prv_7ZlQREDScH0xkhUwtXruN\", \"orchestrated\": False}\n ],\n evaluators=[{\"version_id\": \"evv_012def\", \"orchestrated\": False}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.create({\n dataset: {\n versionId: \"dsv_6L78pqrdFi2xa\"\n },\n evaluatees: [{\n versionId: \"prv_7ZlQREDScH0xkhUwtXruN\",\n orchestrated: false\n }],\n evaluators: [{\n versionId: \"evv_012def\",\n orchestrated: false\n }]\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.create(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "dataset: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.environment" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "evaluatees: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "batchId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "batch_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "orchestrated: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "orchestrated" + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "evaluatees" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "evaluators: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "orchestrated: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "orchestrated" + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "evaluators" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "file: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "file.id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "file.path" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.get": { + "id": "endpoint_evaluations.get", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Get an Evaluation.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluation." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/ev_567yza", + "responseStatusCode": 200, + "name": "Get evaluation", + "pathParameters": { + "id": "ev_567yza" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "ev_567yza", + "dataset": { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + }, + "evaluatees": [ + { + "version": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + }, + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "model": "gpt-4o", + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ] + }, + "orchestrated": false + } + ], + "evaluators": [ + { + "version": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + }, + "orchestrated": false + } + ], + "status": "completed", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluations/ev_567yza \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.get(\n id=\"ev_567yza\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.get(\"ev_567yza\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluations/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.get(\n id=\"ev_567yza\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.get(\"ev_567yza\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.delete": { + "id": "endpoint_evaluations.delete", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Delete an Evaluation.\n\nRemove an Evaluation from Humanloop. The Logs and Versions used in the Evaluation\nwill not be deleted.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluation." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/ev_567yza", + "responseStatusCode": 204, + "name": "Delete evaluation", + "pathParameters": { + "id": "ev_567yza" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/evaluations/ev_567yza \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.delete(\n id=\"ev_567yza\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.delete(\"ev_567yza\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.humanloop.com/v5/evaluations/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.delete(\n id=\"ev_567yza\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.delete(\"ev_567yza\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.updateSetup": { + "id": "endpoint_evaluations.updateSetup", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Update an Evaluation.\n\nUpdate the setup of an Evaluation by specifying the Dataset, versions to be\nevaluated (Evaluatees), and which Evaluators to provide judgments.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluation." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "dataset", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluationsDatasetRequest" + } + }, + "description": "Dataset to use in this Evaluation." + }, + { + "key": "evaluatees", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluateeRequest" + } + } + }, + "description": "Unique identifiers for the Prompt/Tool Versions to include in the Evaluation. Can be left unpopulated if you wish to add evaluatees to this Evaluation by specifying `evaluation_id` in Log calls." + }, + { + "key": "evaluators", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationsRequest" + } + } + }, + "description": "The Evaluators used to evaluate." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Evaluation to help identify it. Must be unique within the associated File." + }, + { + "key": "file", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FileRequest" + } + }, + "description": "The File to associate with the Evaluation." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/ev_567yza", + "responseStatusCode": 200, + "name": "Update evaluation", + "pathParameters": { + "id": "ev_567yza" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "dataset": { + "version_id": "dsv_6L78pqrdFi2xa" + }, + "evaluatees": [ + { + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "orchestrated": false + } + ], + "evaluators": [ + { + "version_id": "evv_012def", + "orchestrated": false + } + ] + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "ev_567yza", + "dataset": { + "path": "test-questions", + "id": "ds_345mno", + "name": "test-questions", + "version_id": "dsv_678pqr", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "datapoints_count": 2, + "type": "dataset", + "created_by": { + "id": "usr_v23rSVAgas2a", + "full_name": "Jordan Burges", + "email_address": "jordan@humanloop.com" + }, + "commit_message": "initial commit" + }, + "evaluatees": [ + { + "version": { + "path": "Personal Projects/Coding Assistant", + "id": "pr_30gco7dx6JDq4200GVOHa", + "name": "Coding Assistant", + "version_id": "prv_7ZlQREDScH0xkhUwtXruN", + "type": "prompt", + "environments": [ + { + "id": "env_ffSVxEBzJcBZ1H5jcNMVj", + "created_at": "2023-06-27T23:16:07.992339", + "name": "development", + "tag": "default" + } + ], + "created_at": "2024-07-08T22:40:35.656915", + "updated_at": "2024-07-08T22:40:35.656915", + "created_by": { + "id": "usr_01RJO1k2spBVqNUt1ASef", + "email_address": "raza@humanloop.com", + "full_name": "Raza Habib" + }, + "status": "committed", + "last_used_at": "2024-07-08T22:40:35.656915", + "model": "gpt-4o", + "endpoint": "chat", + "template": [ + { + "content": "You are a helpful coding assistant specialising in {{language}}", + "role": "system" + } + ], + "provider": "openai", + "max_tokens": -1, + "temperature": 0.7, + "top_p": 1, + "presence_penalty": 0, + "frequency_penalty": 0, + "other": {}, + "tools": [], + "linked_tools": [], + "commit_message": "Initial commit", + "version_logs_count": 0, + "total_logs_count": 0, + "inputs": [ + { + "name": "messages" + } + ] + }, + "orchestrated": false + } + ], + "evaluators": [ + { + "version": { + "path": "Shared Evaluators/Accuracy Evaluator", + "id": "ev_890bcd", + "spec": { + "arguments_type": "target_required", + "return_type": "number", + "evaluator_type": "python", + "code": "def evaluate(answer, target):\n return 0.5" + }, + "name": "Accuracy Evaluator", + "version_id": "evv_012def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "answer" + } + ], + "type": "evaluator" + }, + "orchestrated": false + } + ], + "status": "completed", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/evaluations/ev_567yza \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"dataset\": {\n \"version_id\": \"dsv_6L78pqrdFi2xa\"\n },\n \"evaluatees\": [\n {\n \"version_id\": \"prv_7ZlQREDScH0xkhUwtXruN\",\n \"orchestrated\": false\n }\n ],\n \"evaluators\": [\n {\n \"version_id\": \"evv_012def\",\n \"orchestrated\": false\n }\n ]\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.update_setup(\n id=\"ev_567yza\",\n dataset={\"version_id\": \"dsv_6L78pqrdFi2xa\"},\n evaluatees=[\n {\"version_id\": \"prv_7ZlQREDScH0xkhUwtXruN\", \"orchestrated\": False}\n ],\n evaluators=[{\"version_id\": \"evv_012def\", \"orchestrated\": False}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.updateSetup(\"ev_567yza\", {\n dataset: {\n versionId: \"dsv_6L78pqrdFi2xa\"\n },\n evaluatees: [{\n versionId: \"prv_7ZlQREDScH0xkhUwtXruN\",\n orchestrated: false\n }],\n evaluators: [{\n versionId: \"evv_012def\",\n orchestrated: false\n }]\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/evaluations/:id \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.update_setup(\n id=\"ev_567yza\",\n dataset={\"version_id\": \"dsv_6L78pqrdFi2xa\"},\n evaluatees=[\n {\"version_id\": \"prv_7ZlQREDScH0xkhUwtXruN\", \"orchestrated\": False}\n ],\n evaluators=[{\"version_id\": \"evv_012def\", \"orchestrated\": False}],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.updateSetup(\"ev_567yza\", {\n dataset: {\n versionId: \"dsv_6L78pqrdFi2xa\"\n },\n evaluatees: [{\n versionId: \"prv_7ZlQREDScH0xkhUwtXruN\",\n orchestrated: false\n }],\n evaluators: [{\n versionId: \"evv_012def\",\n orchestrated: false\n }]\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.updateSetup(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "dataset: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "dataset.environment" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "evaluatees: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "batchId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "batch_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "orchestrated: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "orchestrated" + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "evaluatees" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "evaluators: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "path" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "environment: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "environment" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "orchestrated: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "orchestrated" + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "evaluators" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "file: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "file.id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "path: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "file.path" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.updateStatus": { + "id": "endpoint_evaluations.updateStatus", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Update the status of an Evaluation.\n\nCan be used to cancel a running Evaluation, or mark an Evaluation that uses\nexternal or human evaluators as completed.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluation." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:EvaluationStatus" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/id/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "status": "pending" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "dataset": { + "path": "path", + "id": "id", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "datapoints_count": 1, + "directory_id": "directory_id", + "type": "dataset", + "environments": [ + { + "id": "id", + "created_at": "2024-01-15T09:30:00Z", + "name": "name", + "tag": "default" + } + ], + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "commit_message": "commit_message", + "datapoints": [ + { + "id": "id" + } + ], + "attributes": { + "key": "value" + } + }, + "evaluatees": [ + { + "version": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "orchestrated": true, + "batch_id": "batch_id" + } + ], + "evaluators": [ + { + "version": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "orchestrated": true + } + ], + "status": "pending", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "name": "name", + "file_id": "file_id", + "created_by": { + "id": "id", + "email_address": "email_address", + "full_name": "full_name" + }, + "url": "url" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/evaluations/id/status \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"status\": \"pending\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.update_status(\n id=\"id\",\n status=\"pending\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.updateStatus(\"id\", {\n status: \"pending\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id/status", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "status": "pending" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.humanloop.com/v5/evaluations/:id/status \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"status\": \"pending\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.update_status(\n id=\"id\",\n status=\"pending\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.updateStatus(\"id\", {\n status: \"pending\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.updateStatus(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "pending": "Humanloop.EvaluationStatus.Pending", + "running": "Humanloop.EvaluationStatus.Running", + "completed": "Humanloop.EvaluationStatus.Completed", + "cancelled": "Humanloop.EvaluationStatus.Cancelled" + }, + "templateString": "status: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "status" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.getStats": { + "id": "endpoint_evaluations.getStats", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Get Evaluation Stats.\n\nRetrieve aggregate stats for the specified Evaluation.\nThis includes the number of generated Logs for each evaluated version and the\ncorresponding Evaluator statistics (such as the mean and percentiles).", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/stats" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Evaluation." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EvaluationStats" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/id/stats", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "overall_stats": { + "num_datapoints": 1, + "total_logs": 1, + "total_evaluator_logs": 1 + }, + "version_stats": [ + { + "version_id": "version_id", + "num_logs": 1, + "evaluator_version_stats": [ + { + "evaluator_version_id": "evaluator_version_id", + "total_logs": 1, + "num_judgments": 1, + "num_nulls": 1, + "num_errors": 1, + "mean": 0, + "std": 1, + "percentiles": { + "0": -2.5, + "25": -0.6745, + "50": 0, + "75": 0.6745, + "100": 2.5 + } + } + ] + } + ], + "status": "pending", + "progress": "progress", + "report": "report" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluations/id/stats \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.get_stats(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.getStats(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id/stats", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluations/:id/stats \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.get_stats(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.getStats(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.getStats(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_evaluations.getLogs": { + "id": "endpoint_evaluations.getLogs", + "namespace": [ + "subpackage_evaluations" + ], + "description": "Get the Logs associated to a specific Evaluation.\n\nEach Datapoint in your Dataset will have a corresponding Log for each File version evaluated.\ne.g. If you have 50 Datapoints and are evaluating 2 Prompts, there will be 100 Logs associated with the Evaluation.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/evaluations/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/logs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of evaluation. Starts with `ev_` or `evr_`." + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page number for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Logs to fetch." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataEvaluationReportLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/evaluations/id/logs", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "evaluated_version": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "datapoint": { + "id": "id" + }, + "evaluator_logs": [ + { + "prompt": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "id": "id", + "evaluator_logs": [ + { + "id": "id", + "evaluator_logs": [], + "evaluator": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + ], + "log": { + "prompt": { + "path": "path", + "id": "id", + "model": "model", + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + }, + "id": "id", + "evaluator_logs": [ + { + "id": "id", + "evaluator_logs": [], + "evaluator": { + "path": "path", + "id": "id", + "spec": { + "arguments_type": "target_free", + "return_type": "boolean", + "evaluator_type": "llm" + }, + "name": "name", + "version_id": "version_id", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z", + "status": "uncommitted", + "last_used_at": "2024-01-15T09:30:00Z", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "name" + } + ] + } + } + ] + } + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/evaluations/id/logs \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.get_logs(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.getLogs(\"id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/evaluations/:id/logs", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/evaluations/:id/logs \\\n -H \"X-API-KEY: \" \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.evaluations.get_logs(\n id=\"id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.evaluations.getLogs(\"id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.evaluations.getLogs(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_logs.list": { + "id": "endpoint_logs.list", + "namespace": [ + "subpackage_logs" + ], + "description": "List all Logs for the given filter criteria.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/logs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "file_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the File to list Logs for." + }, + { + "key": "page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page number for pagination." + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Page size for pagination. Number of Logs to fetch." + }, + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, only Logs belonging to the specified Version will be returned." + }, + { + "key": "version_status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VersionStatus" + } + }, + "description": "If provided, only Logs belonging to Versions with the specified status will be returned." + }, + { + "key": "search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, only Logs that contain the provided string in its inputs and output will be returned." + }, + { + "key": "metadata_search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, only Logs that contain the provided string in its metadata will be returned." + }, + { + "key": "start_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "If provided, only Logs created after the specified date will be returned." + }, + { + "key": "end_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "If provided, only Logs created before the specified date will be returned." + }, + { + "key": "include_parent", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, include the full parent Log in the response. Only applicable when retrieving Evaluator Logs." + }, + { + "key": "in_trace_filter", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, return Logs that are associated to a Trace. False, return Logs that are not associated to a Trace." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaginatedDataLogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs", + "responseStatusCode": 200, + "name": "List logs", + "pathParameters": {}, + "queryParameters": { + "file_id": "file_123abc", + "size": 1 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "records": [ + { + "id": "log_123efg", + "created_at": "2024-05-01T12:00:00Z", + "output": "This is a sample output.", + "prompt": { + "id": "pr_123abc", + "name": "Test Prompt", + "path": "test-prompt", + "version_id": "pv_456def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "model": "gpt-4", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "question" + } + ] + }, + "evaluator_logs": [] + } + ], + "page": 1, + "size": 1, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/logs \\\n -H \"X-API-KEY: \" \\\n -d file_id=file_123abc \\\n -d size=1", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.logs.list(\n file_id=\"file_123abc\",\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.logs.list({\n fileId: \"file_123abc\",\n size: 1\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/logs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "file_id": "string", + "page": 0, + "size": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.humanloop.com/v5/logs \\\n -H \"X-API-KEY: \" \\\n -d file_id=string \\\n -d page=0 \\\n -d size=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nresponse = client.logs.list(\n file_id=\"file_123abc\",\n size=1,\n)\nfor item in response:\n yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.logs.list({\n fileId: \"file_123abc\",\n size: 1\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.logs.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "file_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "page: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "page" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "size: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "size" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "versionId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "version_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "uncommitted": "Humanloop.VersionStatus.Uncommitted", + "committed": "Humanloop.VersionStatus.Committed", + "deleted": "Humanloop.VersionStatus.Deleted" + }, + "templateString": "versionStatus: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "version_status" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "search: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "search" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "metadataSearch: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "metadata_search" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "startDate: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "start_date" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "endDate: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "end_date" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "includeParent: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "include_parent" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "inTraceFilter: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "in_trace_filter" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_logs.delete": { + "id": "endpoint_logs.delete", + "namespace": [ + "subpackage_logs" + ], + "description": "Delete Logs with the given IDs.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/logs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "queryParameters": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifiers for the Logs to delete." + } + ], + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "id": "string" + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://api.humanloop.com/v5/logs?id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.logs.delete(\n id=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.logs.delete({\n id: \"string\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/logs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://api.humanloop.com/v5/logs?id=string\" \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.logs.delete(\n id=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.logs.delete({\n id: \"string\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.logs.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "id: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "endpoint_logs.get": { + "id": "endpoint_logs.get", + "namespace": [ + "subpackage_logs" + ], + "description": "Retrieve the Log with the given ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/logs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.humanloop.com/v5" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for Log." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HttpValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/logs/prv_Wu6zx1lAWJRqOyL8nWuZk", + "responseStatusCode": 200, + "name": "Get log", + "pathParameters": { + "id": "prv_Wu6zx1lAWJRqOyL8nWuZk" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "log_123efg", + "created_at": "2024-05-01T12:00:00Z", + "output": "This is a sample output.", + "prompt": { + "id": "pr_123abc", + "name": "Test Prompt", + "path": "test-prompt", + "version_id": "pv_456def", + "created_at": "2024-05-01T12:00:00Z", + "updated_at": "2024-05-01T12:00:00Z", + "status": "committed", + "last_used_at": "2024-05-01T12:00:00Z", + "model": "gpt-4", + "version_logs_count": 1, + "total_logs_count": 1, + "inputs": [ + { + "name": "question" + } + ] + }, + "evaluator_logs": [] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/logs/prv_Wu6zx1lAWJRqOyL8nWuZk \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.logs.get(\n id=\"prv_Wu6zx1lAWJRqOyL8nWuZk\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.logs.get(\"prv_Wu6zx1lAWJRqOyL8nWuZk\");\n", + "generated": true + } + ] + } + }, + { + "path": "/logs/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.humanloop.com/v5/logs/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from humanloop import Humanloop\n\nclient = Humanloop(\n api_key=\"YOUR_API_KEY\",\n)\nclient.logs.get(\n id=\"prv_Wu6zx1lAWJRqOyL8nWuZk\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumanloopClient } from \"humanloop\";\n\nconst client = new HumanloopClient({ apiKey: \"YOUR_API_KEY\" });\nawait client.logs.get(\"prv_Wu6zx1lAWJRqOyL8nWuZk\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await client.logs.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": { + "type": "generic", + "imports": [ + "import { HumanloopClient } from \"humanloop\";" + ], + "templateString": "const client = new HumanloopClient($FERN_INPUT);", + "isOptional": false, + "inputDelimiter": ",", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{ $FERN_INPUT }", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "apiKey: $FERN_INPUT", + "isOptional": false, + "templateInputs": [ + { + "type": "payload", + "location": "AUTH", + "path": "Authorization" + } + ] + } + } + ] + } + } + ] + } + } + } + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_prompts:PromptLogRequestToolChoice": { + "name": "PromptLogRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_prompts:PromptLogUpdateRequestToolChoice": { + "name": "PromptLogUpdateRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_prompts:PromptsCallStreamRequestToolChoice": { + "name": "PromptsCallStreamRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_prompts:PromptsCallRequestToolChoice": { + "name": "PromptsCallRequestToolChoice", + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_prompts:PromptRequestTemplate": { + "name": "PromptRequestTemplate", + "description": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + } + ] + } + }, + "type_prompts:PromptRequestStop": { + "name": "PromptRequestStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_evaluators:SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec": { + "name": "SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Llm Evaluator Request", + "shape": { + "type": "id", + "id": "type_:LlmEvaluatorRequest" + } + }, + { + "displayName": "Code Evaluator Request", + "shape": { + "type": "id", + "id": "type_:CodeEvaluatorRequest" + } + }, + { + "displayName": "Human Evaluator Request", + "shape": { + "type": "id", + "id": "type_:HumanEvaluatorRequest" + } + }, + { + "displayName": "External Evaluator Request", + "shape": { + "type": "id", + "id": "type_:ExternalEvaluatorRequest" + } + } + ] + } + }, + "type_evaluators:CreateEvaluatorLogRequestJudgment": { + "name": "CreateEvaluatorLogRequestJudgment", + "description": "Evaluator assessment of the Log.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + ] + } + }, + "type_evaluators:CreateEvaluatorLogRequestSpec": { + "name": "CreateEvaluatorLogRequestSpec", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Llm Evaluator Request", + "shape": { + "type": "id", + "id": "type_:LlmEvaluatorRequest" + } + }, + { + "displayName": "Code Evaluator Request", + "shape": { + "type": "id", + "id": "type_:CodeEvaluatorRequest" + } + }, + { + "displayName": "Human Evaluator Request", + "shape": { + "type": "id", + "id": "type_:HumanEvaluatorRequest" + } + }, + { + "displayName": "External Evaluator Request", + "shape": { + "type": "id", + "id": "type_:ExternalEvaluatorRequest" + } + } + ] + } + }, + "type_:BooleanEvaluatorStatsResponse": { + "name": "BooleanEvaluatorStatsResponse", + "description": "Base attributes for stats for an Evaluator Version-Evaluated Version pair\nin the Evaluation Report.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator Version." + }, + { + "key": "total_logs", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Logs generated by this Evaluator Version on the Evaluated Version's Logs. This includes Nulls and Errors." + }, + { + "key": "num_judgments", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Evaluator judgments for this Evaluator Version. This excludes Nulls and Errors." + }, + { + "key": "num_nulls", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of null judgments (i.e. abstentions) for this Evaluator Version." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of errored Evaluators for this Evaluator Version." + }, + { + "key": "num_true", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of `True` judgments for this Evaluator Version." + }, + { + "key": "num_false", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of `False` judgments for this Evaluator Version." + } + ] + } + }, + "type_:ChatMessageContentItem": { + "name": "ChatMessageContentItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Text Chat Content", + "shape": { + "type": "id", + "id": "type_:TextChatContent" + } + }, + { + "displayName": "Image Chat Content", + "shape": { + "type": "id", + "id": "type_:ImageChatContent" + } + } + ] + } + }, + "type_:ChatMessageContent": { + "name": "ChatMessageContent", + "description": "The content of the message.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessageContentItem" + } + } + } + ] + } + }, + "type_:ChatMessage": { + "name": "ChatMessage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessageContent" + } + }, + "description": "The content of the message." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional name of the message author." + }, + { + "key": "tool_call_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Tool call that this message is responding to." + }, + { + "key": "role", + "valueShape": { + "type": "id", + "id": "type_:ChatRole" + }, + "description": "Role of the message author." + }, + { + "key": "tool_calls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolCall" + } + } + }, + "description": "A list of tool calls requested by the assistant." + } + ] + } + }, + "type_:ChatRole": { + "name": "ChatRole", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + }, + { + "value": "system" + }, + { + "value": "tool" + } + ] + } + }, + "type_:CodeEvaluatorRequest": { + "name": "CodeEvaluatorRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "arguments_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + }, + "description": "Whether this Evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorReturnTypeEnum" + }, + "description": "The type of the return value of the Evaluator." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Evaluator. Helpful to separate Evaluator versions from each other with details on how they were created or used." + }, + { + "key": "evaluator_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "python" + } + } + }, + { + "key": "code", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The code for the Evaluator. This code will be executed in a sandboxed environment." + } + ] + } + }, + "type_:CommitRequest": { + "name": "CommitRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "commit_message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Message describing the changes made." + } + ] + } + }, + "type_:CreateDatapointRequestTargetValue": { + "name": "CreateDatapointRequestTargetValue", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:CreateDatapointRequest": { + "name": "CreateDatapointRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The inputs to the prompt template." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "List of chat messages to provide to the model." + }, + { + "key": "target", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:CreateDatapointRequestTargetValue" + } + } + }, + "description": "Object with criteria necessary to evaluate generations with this Datapoint. This is passed in as an argument to Evaluators when used in an Evaluation." + } + ] + } + }, + "type_:CreateEvaluatorLogResponse": { + "name": "CreateEvaluatorLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String identifier of the new Log." + }, + { + "key": "parent_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier of the evaluated parent Log." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier of the Session containing both the parent and the new child Log. If the parent Log does not belong to a Session, a new Session is created with this ID." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier of Evaluator Version for which the Log was registered." + } + ] + } + }, + "type_:CreateFlowLogResponse": { + "name": "CreateFlowLogResponse", + "description": "Response for a Flow Log.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Log." + }, + { + "key": "flow_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Flow." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Flow Version." + }, + { + "key": "trace_status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TraceStatus" + } + }, + "description": "Status of the Trace. When a Trace is marked as `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on `complete` Traces." + } + ] + } + }, + "type_:CreatePromptLogResponse": { + "name": "CreatePromptLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of log." + }, + { + "key": "prompt_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Prompt the log belongs to." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the specific version of the Prompt." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of session the log belongs to." + } + ] + } + }, + "type_:CreateToolLogResponse": { + "name": "CreateToolLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String ID of log." + }, + { + "key": "tool_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Tool the log belongs to." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the specific version of the Tool." + }, + { + "key": "session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String ID of session the log belongs to." + } + ] + } + }, + "type_:DashboardConfiguration": { + "name": "DashboardConfiguration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "time_unit", + "valueShape": { + "type": "id", + "id": "type_:TimeUnit" + } + }, + { + "key": "time_range_days", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "model_config_ids", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:DatapointResponseTargetValue": { + "name": "DatapointResponseTargetValue", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:DatapointResponse": { + "name": "DatapointResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The inputs to the prompt template." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "List of chat messages to provide to the model." + }, + { + "key": "target", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:DatapointResponseTargetValue" + } + } + }, + "description": "Object with criteria necessary to evaluate generations with this Datapoint. This is passed in as an argument to Evaluators when used in an Evaluation." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Datapoint. Starts with `dp_`." + } + ] + } + }, + "type_:DatasetResponse": { + "name": "DatasetResponse", + "description": "Base type that all File Responses should inherit from.\n\nAttributes defined here are common to all File Responses and should be overridden\nin the inheriting classes with documentation and appropriate Field definitions.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Path of the Dataset, including the name, which is used as a unique identifier." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Dataset. Starts with `ds_`." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the directory that the file is in on Humanloop." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the Dataset, which is used as a unique identifier." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific Dataset Version. If no query params provided, the default deployed Dataset Version is returned. Starts with `dsv_`." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "dataset" + } + } + } + }, + { + "key": "environments", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentResponse" + } + } + }, + "description": "The list of environments the Dataset Version is deployed to." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the Dataset." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:VersionStatus" + }, + "description": "The status of the Dataset Version." + }, + { + "key": "last_used_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made. If provided, a committed version of the Dataset is created. Otherwise, an uncommitted version is created." + }, + { + "key": "datapoints_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of Datapoints in this Dataset version." + }, + { + "key": "datapoints", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatapointResponse" + } + } + }, + "description": "The list of Datapoints in this Dataset version. Only provided if explicitly requested." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Dataset. Helpful to separate Dataset versions from each other with details on how they were created or used." + } + ] + } + }, + "type_:EnvironmentResponse": { + "name": "EnvironmentResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "tag", + "valueShape": { + "type": "id", + "id": "type_:EnvironmentTag" + } + } + ] + } + }, + "type_:EnvironmentTag": { + "name": "EnvironmentTag", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "default" + }, + { + "value": "other" + } + ] + } + }, + "type_:EvaluatedVersionResponse": { + "name": "EvaluatedVersionResponse", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Prompt Response", + "shape": { + "type": "id", + "id": "type_:PromptResponse" + } + }, + { + "displayName": "Tool Response", + "shape": { + "type": "id", + "id": "type_:ToolResponse" + } + }, + { + "displayName": "Evaluator Response", + "shape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + { + "displayName": "Flow Response", + "shape": { + "type": "id", + "id": "type_:FlowResponse" + } + } + ] + } + }, + "type_:EvaluateeRequest": { + "name": "EvaluateeRequest", + "description": "Specification of a File version on Humanloop.\n\nThis can be done in a couple of ways:\n\n- Specifying `version_id` directly.\n- Specifying a File (and optionally an Environment).\n - A File can be specified by either `path` or `file_id`.\n - An Environment can be specified by `environment_id`. If no Environment is specified, the default Environment is used.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the File Version. If provided, none of the other fields should be specified." + }, + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path identifying a File. Provide either this or `file_id` if you want to specify a File." + }, + { + "key": "file_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the File. Provide either this or `path` if you want to specify a File." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment a Version is deployed to. Only provide this when specifying a File. If not provided (and a File is specified), the default Environment is used." + }, + { + "key": "batch_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the batch of Logs to include in the Evaluation Report." + }, + { + "key": "orchestrated", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Prompt/Tool is orchestrated by Humanloop. Default is `True`. If `False`, a log for the Prompt/Tool should be submitted by the user via the API." + } + ] + } + }, + "type_:EvaluateeResponse": { + "name": "EvaluateeResponse", + "description": "Version of the Evaluatee being evaluated.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "id", + "id": "type_:EvaluatedVersionResponse" + } + }, + { + "key": "batch_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the batch of Logs to include in the Evaluation Report." + }, + { + "key": "orchestrated", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Prompt/Tool is orchestrated by Humanloop. Default is `True`. If `False`, a log for the Prompt/Tool should be submitted by the user via the API." + } + ] + } + }, + "type_:EvaluationEvaluatorResponse": { + "name": "EvaluationEvaluatorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + { + "key": "orchestrated", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether the Evaluator is orchestrated by Humanloop. Default is `True`. If `False`, a log for the Evaluator should be submitted by the user via the API." + } + ] + } + }, + "type_:EvaluationReportLogResponse": { + "name": "EvaluationReportLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluated_version", + "valueShape": { + "type": "id", + "id": "type_:EvaluatedVersionResponse" + }, + "description": "The version of the Prompt, Tool or Evaluator that the Log belongs to." + }, + { + "key": "datapoint", + "valueShape": { + "type": "id", + "id": "type_:DatapointResponse" + }, + "description": "The Datapoint used to generate the Log" + }, + { + "key": "log", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LogResponse" + } + }, + "description": "The Log that was evaluated by the Evaluator." + }, + { + "key": "evaluator_logs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogResponse" + } + }, + "description": "The Evaluator Logs containing the judgments for the Log." + } + ] + } + }, + "type_:EvaluationResponse": { + "name": "EvaluationResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluation. Starts with `evr`." + }, + { + "key": "dataset", + "valueShape": { + "type": "id", + "id": "type_:DatasetResponse" + }, + "description": "The Dataset used in the Evaluation." + }, + { + "key": "evaluatees", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluateeResponse" + } + }, + "description": "The Prompt/Tool Versions included in the Evaluation." + }, + { + "key": "evaluators", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationEvaluatorResponse" + } + }, + "description": "The Evaluator Versions used to evaluate." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:EvaluationStatus" + }, + "description": "The current status of the Evaluation.\n\n- `\"pending\"`: The Evaluation has been created but is not actively being worked on by Humanloop.\n- `\"running\"`: Humanloop is checking for any missing Logs and Evaluator Logs, and will generate them where appropriate.\n- `\"completed\"`: All Logs an Evaluator Logs have been generated.\n- `\"cancelled\"`: The Evaluation has been cancelled by the user. Humanloop will stop generating Logs and Evaluator Logs." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Evaluation to help identify it. Must be unique among Evaluations associated with File." + }, + { + "key": "file_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the File associated with the Evaluation." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL to view the Evaluation on the Humanloop." + } + ] + } + }, + "type_:EvaluationStats": { + "name": "EvaluationStats", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "overall_stats", + "valueShape": { + "type": "id", + "id": "type_:OverallStats" + }, + "description": "Stats for the Evaluation Report as a whole." + }, + { + "key": "version_stats", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VersionStatsResponse" + } + }, + "description": "Stats for each Evaluated Version in the Evaluation Report." + }, + { + "key": "progress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A summary string report of the Evaluation's progress you can print to the command line;helpful when integrating Evaluations with CI/CD." + }, + { + "key": "report", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A summary string report of the Evaluation you can print to command line;helpful when integrating Evaluations with CI/CD." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:EvaluationStatus" + }, + "description": "The current status of the Evaluation." + } + ] + } + }, + "type_:EvaluationStatus": { + "name": "EvaluationStatus", + "description": "Status of an evaluation.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "running" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + } + ] + } + }, + "type_:EvaluatorActivationDeactivationRequestActivateItem": { + "name": "EvaluatorActivationDeactivationRequestActivateItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Monitoring Evaluator Version Request", + "shape": { + "type": "id", + "id": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "displayName": "Monitoring Evaluator Environment Request", + "shape": { + "type": "id", + "id": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ] + } + }, + "type_:EvaluatorActivationDeactivationRequestDeactivateItem": { + "name": "EvaluatorActivationDeactivationRequestDeactivateItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Monitoring Evaluator Version Request", + "shape": { + "type": "id", + "id": "type_:MonitoringEvaluatorVersionRequest" + } + }, + { + "displayName": "Monitoring Evaluator Environment Request", + "shape": { + "type": "id", + "id": "type_:MonitoringEvaluatorEnvironmentRequest" + } + } + ] + } + }, + "type_:EvaluatorActivationDeactivationRequest": { + "name": "EvaluatorActivationDeactivationRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "activate", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorActivationDeactivationRequestActivateItem" + } + } + }, + "description": "Evaluators to activate for Monitoring. These will be automatically run on new Logs." + }, + { + "key": "deactivate", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorActivationDeactivationRequestDeactivateItem" + } + } + }, + "description": "Evaluators to deactivate. These will not be run on new Logs." + } + ] + } + }, + "type_:EvaluatorAggregate": { + "name": "EvaluatorAggregate", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The aggregated value of the evaluator." + }, + { + "key": "evaluator_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the evaluator." + }, + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the evaluator version." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + ] + } + }, + "type_:EvaluatorArgumentsType": { + "name": "EvaluatorArgumentsType", + "description": "Enum representing the possible argument types of an evaluator.", + "shape": { + "type": "enum", + "values": [ + { + "value": "target_free" + }, + { + "value": "target_required" + } + ] + } + }, + "type_:EvaluatorJudgmentNumberLimit": { + "name": "EvaluatorJudgmentNumberLimit", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "min", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The minimum value that can be selected." + }, + { + "key": "max", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The maximum value that can be selected." + }, + { + "key": "step", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The step size for the number input." + } + ] + } + }, + "type_:EvaluatorJudgmentOptionResponse": { + "name": "EvaluatorJudgmentOptionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the option." + }, + { + "key": "valence", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Valence" + } + }, + "description": "Whether this option should be considered positive or negative." + } + ] + } + }, + "type_:EvaluatorLogResponseJudgment": { + "name": "EvaluatorLogResponseJudgment", + "description": "Evaluator assessment of the Log.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + ] + } + }, + "type_:EvaluatorLogResponse": { + "name": "EvaluatorLogResponse", + "description": "General request for creating a Log", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier of the evaluated Log. The newly created Log will have this one set as parent." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "judgment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluatorLogResponseJudgment" + } + }, + "description": "Evaluator assessment of the Log." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Log." + }, + { + "key": "evaluator_logs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorLogResponse" + } + }, + "description": "List of Evaluator Logs associated with the Log. These contain Evaluator judgments on the Log." + }, + { + "key": "trace_flow_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Flow that the Trace belongs to." + }, + { + "key": "trace_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Trace that the Log belongs to." + }, + { + "key": "trace_children", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "description": "Logs nested under this Log in the Trace." + }, + { + "key": "evaluator", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorResponse" + }, + "description": "Evaluator used to generate the judgment." + }, + { + "key": "parent", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LogResponse" + } + }, + "description": "The Log that was evaluated. Only provided if the ?include_parent query parameter is set for the" + } + ] + } + }, + "type_:EvaluatorResponseSpec": { + "name": "EvaluatorResponseSpec", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Llm Evaluator Request", + "shape": { + "type": "id", + "id": "type_:LlmEvaluatorRequest" + } + }, + { + "displayName": "Code Evaluator Request", + "shape": { + "type": "id", + "id": "type_:CodeEvaluatorRequest" + } + }, + { + "displayName": "Human Evaluator Request", + "shape": { + "type": "id", + "id": "type_:HumanEvaluatorRequest" + } + }, + { + "displayName": "External Evaluator Request", + "shape": { + "type": "id", + "id": "type_:ExternalEvaluatorRequest" + } + } + ] + } + }, + "type_:EvaluatorResponse": { + "name": "EvaluatorResponse", + "description": "Version of the Evaluator used to provide judgments.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Path of the Evaluator including the Evaluator name, which is used as a unique identifier." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the directory that the file is in on Humanloop." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made." + }, + { + "key": "spec", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorResponseSpec" + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the Evaluator, which is used as a unique identifier." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific Evaluator Version. If no query params provided, the default deployed Evaluator Version is returned." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "evaluator" + } + } + } + }, + { + "key": "environments", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentResponse" + } + } + }, + "description": "The list of environments the Evaluator Version is deployed to." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the Evaluator." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:VersionStatus" + } + }, + { + "key": "last_used_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "version_logs_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of logs that have been generated for this Evaluator Version" + }, + { + "key": "total_logs_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of logs that have been generated across all Evaluator Versions" + }, + { + "key": "inputs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:InputResponse" + } + }, + "description": "Inputs associated to the Evaluator. Inputs correspond to any of the variables used within the Evaluator template." + }, + { + "key": "evaluators", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:MonitoringEvaluatorResponse" + } + } + }, + "description": "Evaluators that have been attached to this Evaluator that are used for monitoring logs." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorAggregate" + } + } + }, + "description": "Aggregation of Evaluator results for the Evaluator Version." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Evaluator. Helpful to separate Evaluator versions from each other with details on how they were created or used." + } + ] + } + }, + "type_:EvaluatorReturnTypeEnum": { + "name": "EvaluatorReturnTypeEnum", + "description": "Enum representing the possible return types of an evaluator.", + "shape": { + "type": "enum", + "values": [ + { + "value": "boolean" + }, + { + "value": "number" + }, + { + "value": "select" + }, + { + "value": "multi_select" + }, + { + "value": "text" + } + ] + } + }, + "type_:ExternalEvaluatorRequest": { + "name": "ExternalEvaluatorRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "arguments_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + }, + "description": "Whether this Evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorReturnTypeEnum" + }, + "description": "The type of the return value of the Evaluator." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Evaluator. Helpful to separate Evaluator versions from each other with details on how they were created or used." + }, + { + "key": "evaluator_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "external" + } + } + } + ] + } + }, + "type_:FileEnvironmentResponseFile": { + "name": "FileEnvironmentResponseFile", + "description": "The version of the File that is deployed to the Environment, if one is deployed.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Prompt Response", + "shape": { + "type": "id", + "id": "type_:PromptResponse" + } + }, + { + "displayName": "Tool Response", + "shape": { + "type": "id", + "id": "type_:ToolResponse" + } + }, + { + "displayName": "Dataset Response", + "shape": { + "type": "id", + "id": "type_:DatasetResponse" + } + }, + { + "displayName": "Evaluator Response", + "shape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + { + "displayName": "Flow Response", + "shape": { + "type": "id", + "id": "type_:FlowResponse" + } + } + ] + } + }, + "type_:FileEnvironmentResponse": { + "name": "FileEnvironmentResponse", + "description": "Response model for the List Environments endpoint under Files.\n\nContains the deployed version of the File, if one is deployed to the Environment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "tag", + "valueShape": { + "type": "id", + "id": "type_:EnvironmentTag" + } + }, + { + "key": "file", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FileEnvironmentResponseFile" + } + }, + "description": "The version of the File that is deployed to the Environment, if one is deployed." + } + ] + } + }, + "type_:FileRequest": { + "name": "FileRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for an existing File." + }, + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path of the File, including the name. This locates the File in the Humanloop filesystem and is used as as a unique identifier. Example: `folder/name` or just `name`." + } + ] + } + }, + "type_:FileType": { + "name": "FileType", + "description": "Enum for File types.", + "shape": { + "type": "enum", + "values": [ + { + "value": "prompt" + }, + { + "value": "tool" + }, + { + "value": "dataset" + }, + { + "value": "evaluator" + }, + { + "value": "flow" + } + ] + } + }, + "type_:FlowKernelRequest": { + "name": "FlowKernelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "attributes", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + }, + "description": "A key-value object identifying the Flow Version." + } + ] + } + }, + "type_:FlowLogResponse": { + "name": "FlowLogResponse", + "description": "General request for creating a Log", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the Flow Log." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Log." + }, + { + "key": "evaluator_logs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorLogResponse" + } + }, + "description": "List of Evaluator Logs associated with the Log. These contain Evaluator judgments on the Log." + }, + { + "key": "trace_flow_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Flow that the Trace belongs to." + }, + { + "key": "trace_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Trace that the Log belongs to." + }, + { + "key": "trace_children", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "description": "Logs nested under this Log in the Trace." + }, + { + "key": "flow", + "valueShape": { + "type": "id", + "id": "type_:FlowResponse" + }, + "description": "Flow used to generate the Log." + }, + { + "key": "trace_status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TraceStatus" + } + }, + "description": "Status of the Trace. When a Trace is marked as `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on completed Traces." + } + ] + } + }, + "type_:FlowResponse": { + "name": "FlowResponse", + "description": "Response model for a Flow.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Path of the Flow, including the name, which is used as a unique identifier." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Flow. Starts with fl\\_." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the directory that the file is in on Humanloop." + }, + { + "key": "attributes", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + }, + "description": "A key-value object identifying the Flow Version." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made. If provided, a committed version of the Flow is created. Otherwise, an uncommitted version is created." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the Flow." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific Flow Version. If no query params provided, the default deployed Flow Version is returned." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "flow" + } + } + } + }, + { + "key": "environments", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentResponse" + } + } + }, + "description": "The list of environments the Flow Version is deployed to." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the Flow." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:VersionStatus" + }, + "description": "The status of the Flow Version." + }, + { + "key": "last_used_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "version_logs_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of logs that have been generated for this Flow Version" + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorAggregate" + } + } + }, + "description": "Aggregation of Evaluator results for the Flow Version." + }, + { + "key": "evaluators", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:MonitoringEvaluatorResponse" + } + } + }, + "description": "The list of Monitoring Evaluators associated with the Flow Version." + } + ] + } + }, + "type_:FunctionTool": { + "name": "FunctionTool", + "description": "A function tool to be called by the model where user owns runtime.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "arguments", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:FunctionToolChoice": { + "name": "FunctionToolChoice", + "description": "A function tool to be called by the model where user owns runtime.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:HttpValidationError": { + "name": "HttpValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ValidationError" + } + } + } + } + ] + } + }, + "type_:HumanEvaluatorRequestReturnType": { + "name": "HumanEvaluatorRequestReturnType", + "description": "The type of the return value of the Evaluator.", + "shape": { + "type": "enum", + "values": [ + { + "value": "select" + }, + { + "value": "multi_select" + }, + { + "value": "text" + }, + { + "value": "number" + }, + { + "value": "boolean" + } + ] + } + }, + "type_:HumanEvaluatorRequest": { + "name": "HumanEvaluatorRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "arguments_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + }, + "description": "Whether this Evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "id", + "id": "type_:HumanEvaluatorRequestReturnType" + }, + "description": "The type of the return value of the Evaluator." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Evaluator. Helpful to separate Evaluator versions from each other with details on how they were created or used." + }, + { + "key": "evaluator_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "human" + } + } + }, + { + "key": "instructions", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Instructions for the Human annotating the ." + }, + { + "key": "options", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorJudgmentOptionResponse" + } + } + }, + "description": "The options that the Human annotator can choose from." + }, + { + "key": "number_limits", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluatorJudgmentNumberLimit" + } + }, + "description": "Limits on the judgment that can be applied. Only for Evaluators with `return_type` of `'number'`." + }, + { + "key": "number_valence", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Valence" + } + }, + "description": "The valence of the number judgment. Only for Evaluators with `return_type` of `'number'`. If 'positive', a higher number is better. If 'negative', a lower number is better." + } + ] + } + }, + "type_:ImageChatContent": { + "name": "ImageChatContent", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "image_url" + } + } + }, + { + "key": "image_url", + "valueShape": { + "type": "id", + "id": "type_:ImageUrl" + }, + "description": "The message's image content." + } + ] + } + }, + "type_:ImageUrlDetail": { + "name": "ImageUrlDetail", + "description": "Specify the detail level of the image provided to the model. For more details see: https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding", + "shape": { + "type": "enum", + "values": [ + { + "value": "high" + }, + { + "value": "low" + }, + { + "value": "auto" + } + ] + } + }, + "type_:ImageUrl": { + "name": "ImageUrl", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Either a URL of the image or the base64 encoded image data." + }, + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageUrlDetail" + } + }, + "description": "Specify the detail level of the image provided to the model. For more details see: https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding" + } + ] + } + }, + "type_:InputResponse": { + "name": "InputResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Type of input." + } + ] + } + }, + "type_:LlmEvaluatorRequest": { + "name": "LlmEvaluatorRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "arguments_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorArgumentsType" + }, + "description": "Whether this Evaluator is target-free or target-required." + }, + { + "key": "return_type", + "valueShape": { + "type": "id", + "id": "type_:EvaluatorReturnTypeEnum" + }, + "description": "The type of the return value of the Evaluator." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Evaluator. Helpful to separate Evaluator versions from each other with details on how they were created or used." + }, + { + "key": "evaluator_type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "llm" + } + } + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptKernelRequest" + } + }, + "description": "The prompt parameters used to generate." + } + ] + } + }, + "type_:LinkedToolResponse": { + "name": "LinkedToolResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name for the tool referenced by the model." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Description of the tool referenced by the model" + }, + { + "key": "strict", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, forces the model to output json data in the structure of the parameters schema." + }, + { + "key": "parameters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Parameters needed to run the Tool, defined in JSON Schema format: https://json-schema.org/" + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Tool linked." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Tool Version linked." + } + ] + } + }, + "type_:ListDatasets": { + "name": "ListDatasets", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatasetResponse" + } + }, + "description": "The list of Datasets." + } + ] + } + }, + "type_:ListEvaluators": { + "name": "ListEvaluators", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + "description": "The list of Evaluators." + } + ] + } + }, + "type_:ListFlows": { + "name": "ListFlows", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FlowResponse" + } + }, + "description": "The list of Flows." + } + ] + } + }, + "type_:ListPrompts": { + "name": "ListPrompts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PromptResponse" + } + }, + "description": "The list of Prompts." + } + ] + } + }, + "type_:ListTools": { + "name": "ListTools", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolResponse" + } + }, + "description": "The list of Tools." + } + ] + } + }, + "type_:LogResponse": { + "name": "LogResponse", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Prompt Log Response", + "shape": { + "type": "id", + "id": "type_:PromptLogResponse" + } + }, + { + "displayName": "Tool Log Response", + "shape": { + "type": "id", + "id": "type_:ToolLogResponse" + } + }, + { + "displayName": "Evaluator Log Response", + "shape": { + "type": "id", + "id": "type_:EvaluatorLogResponse" + } + }, + { + "displayName": "Flow Log Response", + "shape": { + "type": "id", + "id": "type_:FlowLogResponse" + } + } + ] + } + }, + "type_:ModelEndpoints": { + "name": "ModelEndpoints", + "description": "Supported model provider endpoints.", + "shape": { + "type": "enum", + "values": [ + { + "value": "complete" + }, + { + "value": "chat" + }, + { + "value": "edit" + } + ] + } + }, + "type_:ModelProviders": { + "name": "ModelProviders", + "description": "Supported model providers.", + "shape": { + "type": "enum", + "values": [ + { + "value": "openai" + }, + { + "value": "openai_azure" + }, + { + "value": "mock" + }, + { + "value": "anthropic" + }, + { + "value": "bedrock" + }, + { + "value": "cohere" + }, + { + "value": "replicate" + }, + { + "value": "google" + }, + { + "value": "groq" + } + ] + } + }, + "type_:MonitoringEvaluatorEnvironmentRequest": { + "name": "MonitoringEvaluatorEnvironmentRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluator_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator to be used for monitoring." + }, + { + "key": "environment_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Environment. The Evaluator Version deployed to this Environment will be used for monitoring." + } + ] + } + }, + "type_:MonitoringEvaluatorResponse": { + "name": "MonitoringEvaluatorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_reference", + "valueShape": { + "type": "id", + "id": "type_:VersionReferenceResponse" + }, + "description": "The Evaluator Version used for monitoring. This can be a specific Version by ID, or a Version deployed to an Environment." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + "description": "The deployed Version." + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:MonitoringEvaluatorState" + }, + "description": "The state of the Monitoring Evaluator. Either `active` or `inactive`" + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + ] + } + }, + "type_:MonitoringEvaluatorState": { + "name": "MonitoringEvaluatorState", + "description": "State of an evaluator connected to a file", + "shape": { + "type": "enum", + "values": [ + { + "value": "active" + }, + { + "value": "inactive" + } + ] + } + }, + "type_:MonitoringEvaluatorVersionRequest": { + "name": "MonitoringEvaluatorVersionRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator Version to be used for monitoring." + } + ] + } + }, + "type_:NumericEvaluatorStatsResponse": { + "name": "NumericEvaluatorStatsResponse", + "description": "Base attributes for stats for an Evaluator Version-Evaluated Version pair\nin the Evaluation Report.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator Version." + }, + { + "key": "total_logs", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Logs generated by this Evaluator Version on the Evaluated Version's Logs. This includes Nulls and Errors." + }, + { + "key": "num_judgments", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Evaluator judgments for this Evaluator Version. This excludes Nulls and Errors." + }, + { + "key": "num_nulls", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of null judgments (i.e. abstentions) for this Evaluator Version." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of errored Evaluators for this Evaluator Version." + }, + { + "key": "mean", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "std", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "percentiles", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "type_:ObservabilityStatus": { + "name": "ObservabilityStatus", + "description": "Status of a Log for observability.\n\nObservability is implemented by running monitoring Evaluators on Logs.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "running" + }, + { + "value": "completed" + }, + { + "value": "failed" + } + ] + } + }, + "type_:OverallStats": { + "name": "OverallStats", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "num_datapoints", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Datapoints in the Evaluation Report's Dataset Version." + }, + { + "key": "total_logs", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Logs in the Evaluation Report." + }, + { + "key": "total_evaluator_logs", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Evaluator Logs in the Evaluation Report." + } + ] + } + }, + "type_:PaginatedDatapointResponse": { + "name": "PaginatedDatapointResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatapointResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDatasetResponse": { + "name": "PaginatedDatasetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatasetResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataEvaluationReportLogResponse": { + "name": "PaginatedDataEvaluationReportLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationReportLogResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedEvaluationResponse": { + "name": "PaginatedEvaluationResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluationResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataEvaluatorResponse": { + "name": "PaginatedDataEvaluatorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataFlowResponse": { + "name": "PaginatedDataFlowResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FlowResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataLogResponse": { + "name": "PaginatedDataLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataPromptResponse": { + "name": "PaginatedDataPromptResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PromptResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataToolResponse": { + "name": "PaginatedDataToolResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolResponse" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem": { + "name": "PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Prompt Response", + "shape": { + "type": "id", + "id": "type_:PromptResponse" + } + }, + { + "displayName": "Tool Response", + "shape": { + "type": "id", + "id": "type_:ToolResponse" + } + }, + { + "displayName": "Dataset Response", + "shape": { + "type": "id", + "id": "type_:DatasetResponse" + } + }, + { + "displayName": "Evaluator Response", + "shape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + { + "displayName": "Flow Response", + "shape": { + "type": "id", + "id": "type_:FlowResponse" + } + } + ] + } + }, + "type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse": { + "name": "PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PaginatedDataUnionPromptResponseToolResponseDatasetResponseEvaluatorResponseFlowResponseRecordsItem" + } + } + }, + { + "key": "page", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:PlatformAccessEnum": { + "name": "PlatformAccessEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "superadmin" + }, + { + "value": "supportadmin" + }, + { + "value": "user" + } + ] + } + }, + "type_:ProjectSortBy": { + "name": "ProjectSortBy", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "created_at" + }, + { + "value": "updated_at" + }, + { + "value": "name" + } + ] + } + }, + "type_:PromptCallLogResponse": { + "name": "PromptCallLogResponse", + "description": "Sample specific response details for a Prompt call", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "output_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessage" + } + }, + "description": "The message returned by the provider." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the prompt used to generate the output." + }, + { + "key": "output_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the output generated by the model." + }, + { + "key": "prompt_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the prompt." + }, + { + "key": "output_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the output." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Reason the generation finished." + }, + { + "key": "index", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index of the sample in the batch." + } + ] + } + }, + "type_:PromptCallResponseToolChoice": { + "name": "PromptCallResponseToolChoice", + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_:PromptCallResponse": { + "name": "PromptCallResponse", + "description": "Response model for a Prompt call with potentially multiple log samples.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptCallResponseToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function." + }, + { + "key": "prompt", + "valueShape": { + "type": "id", + "id": "type_:PromptResponse" + }, + "description": "Prompt used to generate the Log." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the log." + }, + { + "key": "trace_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the Trace containing the Prompt Call Log." + }, + { + "key": "logs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PromptCallLogResponse" + } + }, + "description": "The logs generated by the Prompt call." + } + ] + } + }, + "type_:PromptCallStreamResponse": { + "name": "PromptCallStreamResponse", + "description": "Response model for calling Prompt in streaming mode.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "output_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessage" + } + }, + "description": "The message returned by the provider." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the prompt used to generate the output." + }, + { + "key": "output_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the output generated by the model." + }, + { + "key": "prompt_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the prompt." + }, + { + "key": "output_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the output." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Reason the generation finished." + }, + { + "key": "index", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index of the sample in the batch." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the log." + }, + { + "key": "prompt_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Prompt the log belongs to." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the specific version of the Prompt." + } + ] + } + }, + "type_:PromptKernelRequestTemplate": { + "name": "PromptKernelRequestTemplate", + "description": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + } + ] + } + }, + "type_:PromptKernelRequestStop": { + "name": "PromptKernelRequestStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PromptKernelRequest": { + "name": "PromptKernelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used, e.g. `gpt-4`. See [supported models](https://humanloop.com/docs/supported-models)" + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "The provider model endpoint used." + }, + { + "key": "template", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptKernelRequestTemplate" + } + }, + "description": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptKernelRequestStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only `{\"type\": \"json_object\"}` is currently supported for chat." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolFunction" + } + } + }, + "description": "The tool specification that the model can choose to call if Tool calling is supported." + }, + { + "key": "linked_tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "The IDs of the Tools in your organization that the model can choose to call if Tool calling is supported. The default deployed version of that tool is called." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Prompt. Helpful to separate Prompt versions from each other with details on how they were created or used." + } + ] + } + }, + "type_:PromptLogResponseToolChoice": { + "name": "PromptLogResponseToolChoice", + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "none" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "auto" + } + } + }, + { + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "required" + } + } + }, + { + "displayName": "Tool Choice", + "shape": { + "type": "id", + "id": "type_:ToolChoice" + } + } + ] + } + }, + "type_:PromptLogResponse": { + "name": "PromptLogResponse", + "description": "General request for creating a Log", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessage" + } + }, + "description": "The message returned by the provider." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the prompt used to generate the output." + }, + { + "key": "output_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of tokens in the output generated by the model." + }, + { + "key": "prompt_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the prompt." + }, + { + "key": "output_cost", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Cost in dollars associated to the tokens in the output." + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Reason the generation finished." + }, + { + "key": "messages", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + }, + "description": "The messages passed to the to provider chat endpoint." + }, + { + "key": "tool_choice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptLogResponseToolChoice" + } + }, + "description": "Controls how the model uses tools. The following options are supported:\n\n- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt.\n- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt.\n- `'required'` means the model can decide to call one or more of the provided tools.\n- `{'type': 'function', 'function': {name': }}` forces the model to use the named function." + }, + { + "key": "prompt", + "valueShape": { + "type": "id", + "id": "type_:PromptResponse" + }, + "description": "Prompt used to generate the Log." + }, + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Log." + }, + { + "key": "evaluator_logs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorLogResponse" + } + }, + "description": "List of Evaluator Logs associated with the Log. These contain Evaluator judgments on the Log." + }, + { + "key": "trace_flow_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Flow that the Trace belongs to." + }, + { + "key": "trace_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Trace that the Log belongs to." + }, + { + "key": "trace_children", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "description": "Logs nested under this Log in the Trace." + } + ] + } + }, + "type_:PromptResponseTemplate": { + "name": "PromptResponseTemplate", + "description": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ChatMessage" + } + } + } + ] + } + }, + "type_:PromptResponseStop": { + "name": "PromptResponseStop", + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PromptResponse": { + "name": "PromptResponse", + "description": "Base type that all File Responses should inherit from.\n\nAttributes defined here are common to all File Responses and should be overridden\nin the inheriting classes with documentation and appropriate Field definitions.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Path of the Prompt, including the name, which is used as a unique identifier." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Prompt." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the directory that the file is in on Humanloop." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model instance used, e.g. `gpt-4`. See [supported models](https://humanloop.com/docs/supported-models)" + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelEndpoints" + } + }, + "description": "The provider model endpoint used." + }, + { + "key": "template", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptResponseTemplate" + } + }, + "description": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}." + }, + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelProviders" + } + }, + "description": "The company providing the underlying model service." + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + }, + "description": "The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt" + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "What sampling temperature to use when making a generation. Higher values means the model will be more creative." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass." + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PromptResponseStop" + } + }, + "description": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0 + } + } + }, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far." + }, + { + "key": "other", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Other parameter values to be passed to the provider call." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If specified, model will make a best effort to sample deterministically, but it is not guaranteed." + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ResponseFormat" + } + }, + "description": "The format of the response. Only `{\"type\": \"json_object\"}` is currently supported for chat." + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToolFunction" + } + } + }, + "description": "The tool specification that the model can choose to call if Tool calling is supported." + }, + { + "key": "linked_tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LinkedToolResponse" + } + } + }, + "description": "The tools linked to your prompt that the model can call." + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Prompt. Helpful to separate Prompt versions from each other with details on how they were created or used." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the Prompt." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific Prompt Version. If no query params provided, the default deployed Prompt Version is returned." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "prompt" + } + } + } + }, + { + "key": "environments", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentResponse" + } + } + }, + "description": "The list of environments the Prompt Version is deployed to." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the Prompt." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:VersionStatus" + }, + "description": "The status of the Prompt Version." + }, + { + "key": "last_used_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "version_logs_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of logs that have been generated for this Prompt Version" + }, + { + "key": "total_logs_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of logs that have been generated across all Prompt Versions" + }, + { + "key": "inputs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:InputResponse" + } + }, + "description": "Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Prompt template." + }, + { + "key": "evaluators", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:MonitoringEvaluatorResponse" + } + } + }, + "description": "Evaluators that have been attached to this Prompt that are used for monitoring logs." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorAggregate" + } + } + }, + "description": "Aggregation of Evaluator results for the Prompt Version." + } + ] + } + }, + "type_:ProviderApiKeys": { + "name": "ProviderApiKeys", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "openai", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "ai21", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mock", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "anthropic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "bedrock", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "cohere", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "openai_azure", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "openai_azure_endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ResponseFormatType": { + "name": "ResponseFormatType", + "shape": { + "type": "enum", + "values": [ + { + "value": "json_object" + }, + { + "value": "json_schema" + } + ] + } + }, + "type_:ResponseFormat": { + "name": "ResponseFormat", + "description": "Response format of the model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ResponseFormatType" + } + }, + { + "key": "json_schema", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The JSON schema of the response format if type is json_schema." + } + ] + } + }, + "type_:SelectEvaluatorStatsResponse": { + "name": "SelectEvaluatorStatsResponse", + "description": "Also used for 'multi_select' Evaluator versions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator Version." + }, + { + "key": "total_logs", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Logs generated by this Evaluator Version on the Evaluated Version's Logs. This includes Nulls and Errors." + }, + { + "key": "num_judgments", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Evaluator judgments for this Evaluator Version. This excludes Nulls and Errors." + }, + { + "key": "num_nulls", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of null judgments (i.e. abstentions) for this Evaluator Version." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of errored Evaluators for this Evaluator Version." + }, + { + "key": "num_judgments_per_option", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of Evaluator judgments for this Evaluator Version. This is a mapping of the option name to the number of judgments for that option." + } + ] + } + }, + "type_:SortOrder": { + "name": "SortOrder", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + }, + "type_:TextChatContent": { + "name": "TextChatContent", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "text" + } + } + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The message's text content." + } + ] + } + }, + "type_:TextEvaluatorStatsResponse": { + "name": "TextEvaluatorStatsResponse", + "description": "Base attributes for stats for an Evaluator Version-Evaluated Version pair\nin the Evaluation Report.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "evaluator_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluator Version." + }, + { + "key": "total_logs", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Logs generated by this Evaluator Version on the Evaluated Version's Logs. This includes Nulls and Errors." + }, + { + "key": "num_judgments", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of Evaluator judgments for this Evaluator Version. This excludes Nulls and Errors." + }, + { + "key": "num_nulls", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of null judgments (i.e. abstentions) for this Evaluator Version." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of errored Evaluators for this Evaluator Version." + } + ] + } + }, + "type_:TimeUnit": { + "name": "TimeUnit", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "day" + }, + { + "value": "week" + }, + { + "value": "month" + } + ] + } + }, + "type_:ToolCall": { + "name": "ToolCall", + "description": "A tool call to be made.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ChatToolType" + } + }, + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:FunctionTool" + } + } + ] + } + }, + "type_:ToolChoice": { + "name": "ToolChoice", + "description": "Tool choice to force the model to use a tool.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ChatToolType" + } + }, + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:FunctionToolChoice" + } + } + ] + } + }, + "type_:ToolFunction": { + "name": "ToolFunction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name for the tool referenced by the model." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Description of the tool referenced by the model" + }, + { + "key": "strict", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If true, forces the model to output json data in the structure of the parameters schema." + }, + { + "key": "parameters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Parameters needed to run the Tool, defined in JSON Schema format: https://json-schema.org/" + } + ] + } + }, + "type_:ToolKernelRequest": { + "name": "ToolKernelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "function", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolFunction" + } + }, + "description": "Callable function specification of the Tool shown to the model for tool calling." + }, + { + "key": "source_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code source of the Tool." + }, + { + "key": "setup_values", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/" + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used." + } + ] + } + }, + "type_:ToolLogResponse": { + "name": "ToolLogResponse", + "description": "General request for creating a Log", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "start_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event started." + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "When the logged event ended." + }, + { + "key": "output", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later." + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "User defined timestamp for when the log was created." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message if the log is an error." + }, + { + "key": "provider_latency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Duration of the logged event in seconds." + }, + { + "key": "stdout", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Captured log and debug statements." + }, + { + "key": "provider_request", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw request sent to provider." + }, + { + "key": "provider_response", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Raw response received the provider." + }, + { + "key": "inputs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "The inputs passed to the prompt template." + }, + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifies where the model was called from." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Any additional metadata to record." + }, + { + "key": "source_datapoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair." + }, + { + "key": "trace_parent_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the parent Log to nest this Log under in a Trace." + }, + { + "key": "batches", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations" + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "End-user ID related to the Log." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Environment the Log is associated to." + }, + { + "key": "save", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request/response payloads will be stored on Humanloop." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Log." + }, + { + "key": "evaluator_logs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorLogResponse" + } + }, + "description": "List of Evaluator Logs associated with the Log. These contain Evaluator judgments on the Log." + }, + { + "key": "trace_flow_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Flow that the Trace belongs to." + }, + { + "key": "trace_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for the Trace that the Log belongs to." + }, + { + "key": "trace_children", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogResponse" + } + } + }, + "description": "Logs nested under this Log in the Trace." + }, + { + "key": "tool", + "valueShape": { + "type": "id", + "id": "type_:ToolResponse" + }, + "description": "Tool used to generate the Log." + } + ] + } + }, + "type_:ToolResponse": { + "name": "ToolResponse", + "description": "Base type that all File Responses should inherit from.\n\nAttributes defined here are common to all File Responses and should be overridden\nin the inheriting classes with documentation and appropriate Field definitions.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "path", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Path of the Tool, including the name, which is used as a unique identifier." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Tool." + }, + { + "key": "directory_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the directory that the file is in on Humanloop." + }, + { + "key": "function", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolFunction" + } + }, + "description": "Callable function specification of the Tool shown to the model for tool calling." + }, + { + "key": "source_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code source of the Tool." + }, + { + "key": "setup_values", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/" + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used." + }, + { + "key": "tool_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilesToolType" + } + }, + "description": "Type of Tool." + }, + { + "key": "commit_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message describing the changes made." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the Tool, which is used as a unique identifier." + }, + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the specific Tool Version. If no query params provided, the default deployed Tool Version is returned." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "tool" + } + } + } + }, + { + "key": "environments", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EnvironmentResponse" + } + } + }, + "description": "The list of environments the Tool Version is deployed to." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "created_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UserResponse" + } + }, + "description": "The user who created the Tool." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:VersionStatus" + }, + "description": "The status of the Tool Version." + }, + { + "key": "last_used_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + { + "key": "version_logs_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of logs that have been generated for this Tool Version" + }, + { + "key": "total_logs_count", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of logs that have been generated across all Tool Versions" + }, + { + "key": "inputs", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:InputResponse" + } + }, + "description": "Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Tool template." + }, + { + "key": "evaluators", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:MonitoringEvaluatorResponse" + } + } + }, + "description": "Evaluators that have been attached to this Tool that are used for monitoring logs." + }, + { + "key": "signature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Signature of the Tool." + }, + { + "key": "evaluator_aggregates", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EvaluatorAggregate" + } + } + }, + "description": "Aggregation of Evaluator results for the Tool Version." + } + ] + } + }, + "type_:TraceStatus": { + "name": "TraceStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "complete" + }, + { + "value": "incomplete" + } + ] + } + }, + "type_:UpdateDatesetAction": { + "name": "UpdateDatesetAction", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "set" + }, + { + "value": "add" + }, + { + "value": "remove" + } + ] + } + }, + "type_:UserResponse": { + "name": "UserResponse", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "type_:Valence": { + "name": "Valence", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "positive" + }, + { + "value": "negative" + }, + { + "value": "neutral" + } + ] + } + }, + "type_:ValidationErrorLocItem": { + "name": "ValidationErrorLocItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:ValidationError": { + "name": "ValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "loc", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ValidationErrorLocItem" + } + } + }, + { + "key": "msg", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:VersionDeploymentResponseFile": { + "name": "VersionDeploymentResponseFile", + "description": "The File that the deployed Version belongs to.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Prompt Response", + "shape": { + "type": "id", + "id": "type_:PromptResponse" + } + }, + { + "displayName": "Tool Response", + "shape": { + "type": "id", + "id": "type_:ToolResponse" + } + }, + { + "displayName": "Dataset Response", + "shape": { + "type": "id", + "id": "type_:DatasetResponse" + } + }, + { + "displayName": "Evaluator Response", + "shape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + { + "displayName": "Flow Response", + "shape": { + "type": "id", + "id": "type_:FlowResponse" + } + } + ] + } + }, + "type_:VersionDeploymentResponse": { + "name": "VersionDeploymentResponse", + "description": "A variable reference to the Version deployed to an Environment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file", + "valueShape": { + "type": "id", + "id": "type_:VersionDeploymentResponseFile" + }, + "description": "The File that the deployed Version belongs to." + }, + { + "key": "environment", + "valueShape": { + "type": "id", + "id": "type_:EnvironmentResponse" + }, + "description": "The Environment that the Version is deployed to." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "environment" + } + } + } + ] + } + }, + "type_:VersionIdResponseVersion": { + "name": "VersionIdResponseVersion", + "description": "The specific Version being referenced.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Prompt Response", + "shape": { + "type": "id", + "id": "type_:PromptResponse" + } + }, + { + "displayName": "Tool Response", + "shape": { + "type": "id", + "id": "type_:ToolResponse" + } + }, + { + "displayName": "Dataset Response", + "shape": { + "type": "id", + "id": "type_:DatasetResponse" + } + }, + { + "displayName": "Evaluator Response", + "shape": { + "type": "id", + "id": "type_:EvaluatorResponse" + } + }, + { + "displayName": "Flow Response", + "shape": { + "type": "id", + "id": "type_:FlowResponse" + } + } + ] + } + }, + "type_:VersionIdResponse": { + "name": "VersionIdResponse", + "description": "A reference to a specific Version by its ID", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "id", + "id": "type_:VersionIdResponseVersion" + }, + "description": "The specific Version being referenced." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "version" + } + } + } + ] + } + }, + "type_:VersionReferenceResponse": { + "name": "VersionReferenceResponse", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Version Deployment Response", + "shape": { + "type": "id", + "id": "type_:VersionDeploymentResponse" + } + }, + { + "displayName": "Version ID Response", + "shape": { + "type": "id", + "id": "type_:VersionIdResponse" + } + } + ] + } + }, + "type_:VersionStatsResponseEvaluatorVersionStatsItem": { + "name": "VersionStatsResponseEvaluatorVersionStatsItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Numeric Evaluator Stats Response", + "shape": { + "type": "id", + "id": "type_:NumericEvaluatorStatsResponse" + } + }, + { + "displayName": "Boolean Evaluator Stats Response", + "shape": { + "type": "id", + "id": "type_:BooleanEvaluatorStatsResponse" + } + }, + { + "displayName": "Select Evaluator Stats Response", + "shape": { + "type": "id", + "id": "type_:SelectEvaluatorStatsResponse" + } + }, + { + "displayName": "Text Evaluator Stats Response", + "shape": { + "type": "id", + "id": "type_:TextEvaluatorStatsResponse" + } + } + ] + } + }, + "type_:VersionStatsResponse": { + "name": "VersionStatsResponse", + "description": "Stats for an Evaluated Version in the Evaluation Report.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the Evaluated Version." + }, + { + "key": "num_logs", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of existing Logs for this Evaluated Version within the Evaluation Report. These are Logs that have been generated by this Evaluated Version on a Datapoint belonging to the Evaluation Report's Dataset Version." + }, + { + "key": "evaluator_version_stats", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VersionStatsResponseEvaluatorVersionStatsItem" + } + }, + "description": "Stats for each Evaluator Version used to evaluate this Evaluated Version." + } + ] + } + }, + "type_:VersionStatus": { + "name": "VersionStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "uncommitted" + }, + { + "value": "committed" + }, + { + "value": "deleted" + } + ] + } + }, + "type_:ChatToolType": { + "name": "ChatToolType", + "description": "The type of tool to call.", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "function" + } + } + } + }, + "type_:FilesToolType": { + "name": "FilesToolType", + "description": "Type of tool.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pinecone_search" + }, + { + "value": "google" + }, + { + "value": "mock" + }, + { + "value": "snippet" + }, + { + "value": "json_schema" + }, + { + "value": "get_api_call" + } + ] + } + }, + "type_:EvaluationsDatasetRequest": { + "name": "EvaluationsDatasetRequest", + "description": "Specification of a File version on Humanloop.\n\nThis can be done in a couple of ways:\n\n- Specifying `version_id` directly.\n- Specifying a File (and optionally an Environment).\n - A File can be specified by either `path` or `file_id`.\n - An Environment can be specified by `environment_id`. If no Environment is specified, the default Environment is used.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the File Version. If provided, none of the other fields should be specified." + }, + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path identifying a File. Provide either this or `file_id` if you want to specify a File." + }, + { + "key": "file_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the File. Provide either this or `path` if you want to specify a File." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment a Version is deployed to. Only provide this when specifying a File. If not provided (and a File is specified), the default Environment is used." + } + ] + } + }, + "type_:EvaluationsRequest": { + "name": "EvaluationsRequest", + "description": "Specification of a File version on Humanloop.\n\nThis can be done in a couple of ways:\n\n- Specifying `version_id` directly.\n- Specifying a File (and optionally an Environment).\n - A File can be specified by either `path` or `file_id`.\n - An Environment can be specified by `environment_id`. If no Environment is specified, the default Environment is used.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the File Version. If provided, none of the other fields should be specified." + }, + { + "key": "path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Path identifying a File. Provide either this or `file_id` if you want to specify a File." + }, + { + "key": "file_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the File. Provide either this or `path` if you want to specify a File." + }, + { + "key": "environment", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the Environment a Version is deployed to. Only provide this when specifying a File. If not provided (and a File is specified), the default Environment is used." + }, + { + "key": "orchestrated", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Evaluator is orchestrated by Humanloop. Default is `True`. If `False`, a log for the Evaluator should be submitted by the user via the API." + } + ] + } + }, + "type_:AgentConfigResponse": { + "name": "AgentConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:EvaluatorConfigResponse": { + "name": "EvaluatorConfigResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:UpdateEvaluationStatusRequest": { + "name": "UpdateEvaluationStatusRequest", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "type_:PaginatedPromptLogResponse": { + "name": "PaginatedPromptLogResponse", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "type_:PaginatedSessionResponse": { + "name": "PaginatedSessionResponse", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "type_:ConfigToolResponse": { + "name": "ConfigToolResponse", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "type_:FeedbackType": { + "name": "FeedbackType", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + "type_:BaseModelsUserResponse": { + "name": "BaseModelsUserResponse", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + }, + "subpackages": { + "subpackage_prompts": { + "id": "subpackage_prompts", + "name": "prompts", + "displayName": "Prompts" + }, + "subpackage_tools": { + "id": "subpackage_tools", + "name": "tools" + }, + "subpackage_datasets": { + "id": "subpackage_datasets", + "name": "datasets", + "displayName": "Datasets" + }, + "subpackage_evaluators": { + "id": "subpackage_evaluators", + "name": "evaluators" + }, + "subpackage_flows": { + "id": "subpackage_flows", + "name": "flows" + }, + "subpackage_files": { + "id": "subpackage_files", + "name": "files" + }, + "subpackage_evaluations": { + "id": "subpackage_evaluations", + "name": "evaluations", + "displayName": "Evaluations" + }, + "subpackage_logs": { + "id": "subpackage_logs", + "name": "logs", + "displayName": "Logs" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-API-KEY", + "nameOverride": "apiKey" + } + } + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/node.json b/packages/fdr-sdk/src/__test__/output/humanloop/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/node.json rename to packages/fdr-sdk/src/__test__/output/humanloop/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/humanloop/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/humanloop/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/humanloop/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/humanloop/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/pageIds.json b/packages/fdr-sdk/src/__test__/output/humanloop/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/pageIds.json rename to packages/fdr-sdk/src/__test__/output/humanloop/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/sitemap.json b/packages/fdr-sdk/src/__test__/output/humanloop/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/sitemap.json rename to packages/fdr-sdk/src/__test__/output/humanloop/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/humanloop/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/humanloop/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/humanloop/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/humanloop/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/slugs.json b/packages/fdr-sdk/src/__test__/output/humanloop/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/slugs.json rename to packages/fdr-sdk/src/__test__/output/humanloop/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/humanloop/versionNodes.json b/packages/fdr-sdk/src/__test__/output/humanloop/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/humanloop/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/humanloop/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-8b03e44c-d4e2-4613-a138-e25b8c65c3cb.json b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-8b03e44c-d4e2-4613-a138-e25b8c65c3cb.json new file mode 100644 index 0000000000..5ce036eef3 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-8b03e44c-d4e2-4613-a138-e25b8c65c3cb.json @@ -0,0 +1,754 @@ +[ + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools/query/restrict_to_most_recent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/request/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/request/object/property/description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/request/object/property/parameters", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/request/object/property/fallback_content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/query/restrict_to_most_recent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/request/object/property/description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/request/object/property/parameters", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/request/object/property/fallback_content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name/request/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.get-tool-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.get-tool-version/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.get-tool-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.get-tool-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool-version/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts/query/restrict_to_most_recent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/request/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/request/object/property/text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/query/restrict_to_most_recent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/request/object/property/text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name/request/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.get-prompt-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.get-prompt-version/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.get-prompt-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.get-prompt-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt-version/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs/query/restrict_to_most_recent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object/property/prompt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object/property/voice", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object/property/language_model", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object/property/tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object/property/builtin_tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/query/restrict_to_most_recent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request/object/property/prompt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request/object/property/voice", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request/object/property/language_model", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request/object/property/tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request/object/property/builtin_tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name/request/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.get-config-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.get-config-version/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.get-config-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.get-config-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config-version/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config-version/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config-version/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config-version/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/path/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/request/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chats/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chats/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chats/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chats/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-groups/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-groups/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-groups/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-groups/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/path/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/query/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/query/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/query/ascending_order", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/example/0/snippet/curl/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/example/0/snippet/typescript/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/query/access_token", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/query/config_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/query/config_version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/query/resumed_chat_group_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/1", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/2", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/3", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/4", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/5", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/6", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/7", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/8", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape/undiscriminatedUnion/variant/9", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/1", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/2", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/3", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/4", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/5", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/6", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape/undiscriminatedUnion/variant/7", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/tool_type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/version_type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/created_on", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/modified_on", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/fallback_content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object/property/parameters", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/version_type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/created_on", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/modified_on", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object/property/text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedBuiltinTool/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedBuiltinTool/shape/object/property/fallback_content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModelModelProvider/shape/enum/value/OPEN_AI", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModelModelProvider/shape/enum/value/CUSTOM_LANGUAGE_MODEL", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModelModelProvider/shape/enum/value/ANTHROPIC", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModelModelProvider/shape/enum/value/FIREWORKS", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModelModelProvider/shape/enum/value/GROQ", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModel/shape/object/property/model_provider", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModel/shape/object/property/model_resource", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModel/shape/object/property/temperature", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedPromptSpec/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedPromptSpec/shape/object/property/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedUserDefinedToolSpec/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedUserDefinedToolSpec/shape/object/property/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoiceName/shape/enum/value/ITO", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoiceName/shape/enum/value/DACHER", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoice/shape/object/property/provider", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoice/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnBuiltinTool/shape/object/property/tool_type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnBuiltinTool/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnBuiltinTool/shape/object/property/fallback_content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/version_description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/created_on", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/modified_on", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/prompt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/voice", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/language_model", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object/property/builtin_tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnLanguageModel/shape/object/property/model_provider", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnLanguageModel/shape/object/property/model_resource", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnLanguageModel/shape/object/property/temperature", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnVoice/shape/object/property/provider", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnVoice/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedUserDefinedTools/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedUserDefinedTools/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedUserDefinedTools/shape/object/property/tools_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedPrompts/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedPrompts/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedPrompts/shape/object/property/prompts_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedConfigs/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedConfigs/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedConfigs/shape/object/property/configs_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/chat_group_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/tag", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/status", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/start_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/end_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/event_count", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/metadata", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object/property/config", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfigSpec/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfigSpec/shape/object/property/version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChats/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChats/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChats/shape/object/property/chats_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/chat_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/role", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/message_text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/emotion_features", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object/property/metadata", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/chat_group_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/tag", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/status", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/start_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/end_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/events_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/metadata", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object/property/config", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount/shape/object/property/timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount/shape/object/property/total_user_active_chats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount/shape/object/property/max_allowed_active_chats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount/shape/object/property/more_active_chats_allowed", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount/shape/object/property/per_tag", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCountPerTag/shape/object/property/tag", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCountPerTag/shape/object/property/total_tag_active_chats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents/shape/object/property/pagination_direction", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents/shape/object/property/events_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/first_start_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/most_recent_start_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/num_chats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/chats_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object/property/active", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape/object/property/first_start_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape/object/property/most_recent_start_timestamp", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape/object/property/most_recent_chat_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape/object/property/num_chats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape/object/property/active", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChatGroups/shape/object/property/page_number", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChatGroups/shape/object/property/page_size", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChatGroups/shape/object/property/chat_groups_page", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantEnd/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantEnd/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantInput/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantInput/shape/object/property/text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantInput/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape/object/property/from_text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape/object/property/message", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape/object/property/models", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioConfiguration/shape/object/property/channels", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioConfiguration/shape/object/property/encoding", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioConfiguration/shape/object/property/sample_rate", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioInput/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioInput/shape/object/property/data", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioInput/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioOutput/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioOutput/shape/object/property/data", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioOutput/shape/object/property/id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioOutput/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:BuiltinToolConfig/shape/object/property/fallback_content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:BuiltinToolConfig/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessageToolResult/shape/undiscriminatedUnion/variant/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessageToolResult/shape/undiscriminatedUnion/variant/1", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessage/shape/object/property/content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessage/shape/object/property/role", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessage/shape/object/property/tool_call", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessage/shape/object/property/tool_result", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMetadata/shape/object/property/chat_group_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMetadata/shape/object/property/chat_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMetadata/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMetadata/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Context/shape/object/property/text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Context/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ContextType/shape/enum/value/editable", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ContextType/shape/enum/value/persistent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ContextType/shape/enum/value/temporary", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Admiration", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Adoration", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Aesthetic Appreciation", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Amusement", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Anger", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Anxiety", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Awe", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Awkwardness", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Boredom", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Calmness", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Concentration", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Confusion", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Contemplation", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Contempt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Contentment", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Craving", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Desire", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Determination", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Disappointment", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Disgust", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Distress", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Doubt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Ecstasy", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Embarrassment", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Empathic Pain", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Entrancement", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Envy", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Excitement", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Fear", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Guilt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Horror", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Interest", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Joy", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Love", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Nostalgia", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Pain", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Pride", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Realization", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Relief", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Romance", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Sadness", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Satisfaction", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Shame", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Surprise (negative)", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Surprise (positive)", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Sympathy", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Tiredness", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object/property/Triumph", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError/shape/object/property/code", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError/shape/object/property/message", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError/shape/object/property/slug", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Inference/shape/object/property/prosody", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:MillisecondInterval/shape/object/property/begin", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:MillisecondInterval/shape/object/property/end", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PauseAssistantMessage/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PauseAssistantMessage/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ProsodyInference/shape/object/property/scores", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ResumeAssistantMessage/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ResumeAssistantMessage/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Role/shape/enum/value/assistant", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Role/shape/enum/value/system", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Role/shape/enum/value/user", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Role/shape/enum/value/all", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Role/shape/enum/value/tool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object/property/audio", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object/property/builtin_tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object/property/language_model_api_key", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object/property/system_prompt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object/property/tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool/shape/object/property/description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool/shape/object/property/fallback_content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool/shape/object/property/parameters", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object/property/name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object/property/parameters", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object/property/response_required", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object/property/tool_call_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object/property/tool_type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/code", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/error", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/level", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/tool_call_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/tool_type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape/object/property/content", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape/object/property/tool_call_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape/object/property/tool_name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape/object/property/tool_type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolType/shape/enum/value/builtin", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolType/shape/enum/value/function", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInput/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInput/shape/object/property/text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInput/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInterruption/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInterruption/shape/object/property/time", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInterruption/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape/object/property/custom_session_id", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape/object/property/from_text", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape/object/property/message", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape/object/property/models", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape/object/property/time", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TtsInput/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TextInput/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:FunctionCallResponseInput/shape/object/property/type", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.get-tool-version/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.get-prompt-version/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.get-config-version/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chats/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-groups/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/response", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/message/server/subscribe/body", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/message/client/publish/body", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:BuiltInTool/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Encoding/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ErrorLevel/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/request/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedBuiltinTool/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModel/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedPromptSpec/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedUserDefinedToolSpec/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoice/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnBuiltinTool/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnLanguageModel/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnVoice/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedUserDefinedTools/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedPrompts/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedConfigs/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfigSpec/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChats/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCountPerTag/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChatGroups/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantEnd/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantInput/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioConfiguration/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioInput/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioOutput/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:BuiltinToolConfig/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMetadata/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Context/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Inference/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:MillisecondInterval/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PauseAssistantMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ProsodyInference/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ResumeAssistantMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInput/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInterruption/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TtsInput/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TextInput/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:FunctionCallResponseInput/shape/object", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/message/server/subscribe", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat/message/client/publish", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModelModelProvider/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoiceName/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:BuiltInTool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessageToolResult/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ContextType/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Encoding", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ErrorLevel", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Role/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolType/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.get-tool-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.get-prompt-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.get-config-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config-version/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chats/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-groups/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events/example/0", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description/request", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:SubscribeEvent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_chat:PublishEvent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedBuiltinTool/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModelModelProvider", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModel/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedPromptSpec/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedUserDefinedToolSpec/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoiceName", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoice/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnBuiltinTool/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnLanguageModel/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnVoice/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedUserDefinedTools/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedPrompts/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedConfigs/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfigSpec/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChats/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCountPerTag/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChatGroups/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantEnd/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantInput/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioConfiguration/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioInput/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioOutput/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:BuiltinToolConfig/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessageToolResult", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMetadata/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Context/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ContextType", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Inference/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:MillisecondInterval/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PauseAssistantMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ProsodyInference/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ResumeAssistantMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Role", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolType", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInput/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInterruption/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TtsInput/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TextInput/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:FunctionCallResponseInput/shape", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/websocket/subpackage_chat.chat", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnUserDefinedTool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPrompt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedBuiltinTool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedLanguageModel", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedPromptSpec", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedUserDefinedToolSpec", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PostedVoice", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnBuiltinTool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfig", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnLanguageModel", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnVoice", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedUserDefinedTools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedPrompts", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedConfigs", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChat", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnConfigSpec", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatEvent", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatPagedEvents", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCount", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnActiveChatCountPerTag", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedEvents", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroupPagedChats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnChatGroup", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ReturnPagedChatGroups", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantEnd", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantInput", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AssistantMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioConfiguration", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioInput", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:AudioOutput", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:BuiltinToolConfig", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ChatMetadata", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Context", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:EmotionScores", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:WebSocketError", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Inference", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:MillisecondInterval", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:PauseAssistantMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ProsodyInference", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ResumeAssistantMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:SessionSettings", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:Tool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolCallMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolErrorMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:ToolResponseMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInput", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserInterruption", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:UserMessage", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TtsInput", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:TextInput", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/type-definition/type_:FunctionCallResponseInput", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tools", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.list-tool-versions", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.create-tool-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.get-tool-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.delete-tool-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_tools.update-tool-description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompts", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.list-prompt-versions", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.create-prompt-verison", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.get-prompt-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.delete-prompt-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_prompts.update-prompt-description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-configs", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.list-config-versions", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.create-config-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-name", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.get-config-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.delete-config-version", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_configs.update-config-description", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chats", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chats.list-chat-events", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-groups", + "8b03e44c-d4e2-4613-a138-e25b8c65c3cb/endpoint/endpoint_chatGroups.list-chat-group-events" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-bcb7826e-ffd6-4440-b3de-6bf37440c3e2.json b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-bcb7826e-ffd6-4440-b3de-6bf37440c3e2.json new file mode 100644 index 0000000000..7712091fdb --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-bcb7826e-ffd6-4440-b3de-6bf37440c3e2.json @@ -0,0 +1,1039 @@ +[ + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files/query/page_number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files/query/page_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.create-files/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.create-files/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/request/formdata/field/file/file/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/request/formdata/field/attributes/file/attributes", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.delete-file/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.delete-file/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.delete-file/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.update-file-name/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.update-file-name/query/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.update-file-name/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.update-file-name/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file-predictions/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file-predictions/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file-predictions/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/query/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/query/page_number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/query/page_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request/formdata/field/name/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request/formdata/field/feature_types/file/feature_types", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request/formdata/field/labels_file/file/labels_file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/request/formdata/field/feature_types/file/feature_types", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/request/formdata/field/labels_file/file/labels_file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.delete-dataset/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.delete-dataset/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.delete-dataset/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/query/page_number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/query/page_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/query/page_number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/query/page_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset-version/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset-version/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset-version/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/query/page_number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/query/page_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/query/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/query/page_number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/query/page_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-details/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-details/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-details/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-name/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-name/query/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-name/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-name/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/query/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/query/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/query/version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-version/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-version/query/shared_assets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-version/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-version/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-description/path/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-description/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-description/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-training-job/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-training-job/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-custom-models-inference-job/example/0/snippet/curl/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-custom-models-inference-job/example/0/snippet/typescript/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AttributeFilter/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AttributeFilter/shape/object/property/value", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileInput/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileInput/shape/object/property/uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileInput/shape/object/property/hume_storage", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileInput/shape/object/property/data_type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributesInput/shape/object/property/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributesInput/shape/object/property/attributes", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/upload_uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/thumbnail_uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/data_type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/created_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/modified_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/hume_storage", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/hume_storage_upload_timestamp", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/is_sanitized", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/is_owned_by_reader", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/is_linked_to_publicly_shared", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object/property/is_linked_to_hume_model", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributes/shape/object/property/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributes/shape/object/property/attributes", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionFeatureTypesValue/shape/enum/value/CATEGORICAL", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionFeatureTypesValue/shape/enum/value/NUMERIC", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionFeatureTypesValue/shape/enum/value/TEXT", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionFeatureTypesValue/shape/enum/value/DATETIME", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionFeatureTypesValue/shape/enum/value/UNDEFINED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object/property/labels_file_uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object/property/feature_types", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object/property/dataset_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object/property/dataset_version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object/property/created_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset/shape/object/property/latest_version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset/shape/object/property/modified_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInputFeatureTypesValue/shape/enum/value/CATEGORICAL", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInputFeatureTypesValue/shape/enum/value/NUMERIC", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInputFeatureTypesValue/shape/enum/value/TEXT", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInputFeatureTypesValue/shape/enum/value/DATETIME", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInputFeatureTypesValue/shape/enum/value/UNDEFINED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInput/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInput/shape/object/property/labels_file_uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInput/shape/object/property/feature_types", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/created_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/modified_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/total_stars", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/model_is_starred_by_user", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/archived", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/latest_version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object/property/is_publicly_shared", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType/shape/enum/value/video", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType/shape/enum/value/audio", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType/shape/enum/value/video_no_audio", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType/shape/enum/value/image", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType/shape/enum/value/text", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType/shape/enum/value/mediapipe_facemesh", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/model_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/source_uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/dataset_version_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/created_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/description", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/tags", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/file_type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/target_feature", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/task_type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object/property/training_job_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionTag/shape/object/property/key", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionTag/shape/object/property/value", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/content", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/pageable", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/total", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/last", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/total_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/total_pages", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/sort", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/first", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/number_of_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object/property/empty", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape/object/property/offset", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape/object/property/sort", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape/object/property/paged", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape/object/property/unpaged", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape/object/property/page_number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape/object/property/page_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortObject/shape/object/property/empty", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortObject/shape/object/property/sorted", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortObject/shape/object/property/unsorted", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JsonObject/shape/object/property/empty", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/content", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/pageable", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/total", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/last", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/total_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/total_pages", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/sort", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/first", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/number_of_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object/property/empty", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/content", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/pageable", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/total", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/last", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/total_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/total_pages", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/sort", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/first", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/number_of_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object/property/empty", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/content", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/pageable", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/total", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/last", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/total_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/total_pages", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/number", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/sort", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/first", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/number_of_elements", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object/property/empty", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/labels_file_uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/feature_type_json_uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/dataset_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/dataset_version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/created_on", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object/property/is_most_recent_version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/zh", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/da", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/nl", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/en", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/en-AU", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/en-IN", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/en-NZ", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/en-GB", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/fr", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/fr-CA", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/de", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/hi", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/hi-Latn", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/it", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/ja", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/ko", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/no", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/pl", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/pt", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/pt-BR", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/pt-PT", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/ru", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/es", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/es-419", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/sv", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/ta", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/tr", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape/enum/value/uk", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BoundingBox/shape/object/property/x", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BoundingBox/shape/object/property/y", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BoundingBox/shape/object/property/w", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BoundingBox/shape/object/property/h", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BurstPrediction/shape/object/property/time", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BurstPrediction/shape/object/property/emotions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BurstPrediction/shape/object/property/descriptions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedEmbeddingGeneration/shape/object/property/created_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedEmbeddingGeneration/shape/object/property/started_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedEmbeddingGeneration/shape/object/property/ended_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference/shape/object/property/created_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference/shape/object/property/started_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference/shape/object/property/ended_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference/shape/object/property/num_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference/shape/object/property/num_errors", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference/shape/object/property/created_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference/shape/object/property/started_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference/shape/object/property/ended_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference/shape/object/property/num_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference/shape/object/property/num_errors", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining/shape/object/property/created_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining/shape/object/property/started_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining/shape/object/property/ended_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining/shape/object/property/custom_model", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining/shape/object/property/alternatives", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelPrediction/shape/object/property/output", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelPrediction/shape/object/property/error", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelPrediction/shape/object/property/task_type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelRequest/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelRequest/shape/object/property/description", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelRequest/shape/object/property/tags", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Dataset/shape/undiscriminatedUnion/variant/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Dataset/shape/undiscriminatedUnion/variant/1", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetId/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionId/shape/object/property/version_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DescriptionsScore/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DescriptionsScore/shape/object/property/score", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Direction/shape/enum/value/asc", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Direction/shape/enum/value/desc", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmbeddingGenerationBaseRequest/shape/object/property/registry_file_details", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmotionScore/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmotionScore/shape/object/property/score", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Error/shape/object/property/message", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Error/shape/object/property/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EvaluationArgs/shape/object/property/validation", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object/property/fps_pred", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object/property/prob_threshold", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object/property/identify_faces", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object/property/min_face_size", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object/property/facs", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object/property/descriptions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object/property/save_faces", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object/property/frame", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object/property/time", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object/property/prob", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object/property/box", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object/property/emotions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object/property/facs", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object/property/descriptions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacemeshPrediction/shape/object/property/emotions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacsScore/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacsScore/shape/object/property/score", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Failed/shape/object/property/created_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Failed/shape/object/property/started_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Failed/shape/object/property/ended_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Failed/shape/object/property/message", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:File/shape/object/property/filename", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:File/shape/object/property/content_type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:File/shape/object/property/md5sum", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Granularity/shape/enum/value/word", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Granularity/shape/enum/value/sentence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Granularity/shape/enum/value/utterance", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Granularity/shape/enum/value/conversational_turn", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsBurstPrediction/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsBurstPrediction/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacePrediction/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacePrediction/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsLanguagePrediction/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsLanguagePrediction/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsNerPrediction/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsNerPrediction/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsProsodyPrediction/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsProsodyPrediction/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InProgress/shape/object/property/created_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InProgress/shape/object/property/started_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object/property/models", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object/property/transcription", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object/property/urls", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object/property/registry_files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object/property/text", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object/property/callback_url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object/property/notify", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferencePrediction/shape/object/property/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferencePrediction/shape/object/property/models", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/models", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/transcription", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/urls", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/registry_files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/text", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/callback_url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/notify", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object/property/files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceResults/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceResults/shape/object/property/errors", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceSourcePredictResult/shape/object/property/source", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceSourcePredictResult/shape/object/property/results", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceSourcePredictResult/shape/object/property/error", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobEmbeddingGeneration/shape/object/property/job_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobEmbeddingGeneration/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobEmbeddingGeneration/shape/object/property/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobEmbeddingGeneration/shape/object/property/state", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobInference/shape/object/property/job_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobInference/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobInference/shape/object/property/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobInference/shape/object/property/state", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTlInference/shape/object/property/job_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTlInference/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTlInference/shape/object/property/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTlInference/shape/object/property/state", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTraining/shape/object/property/job_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTraining/shape/object/property/user_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTraining/shape/object/property/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTraining/shape/object/property/state", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobId/shape/object/property/job_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Language/shape/object/property/granularity", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Language/shape/object/property/sentiment", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Language/shape/object/property/toxicity", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Language/shape/object/property/identify_speakers", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/text", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/position", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/time", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/speaker_confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/emotions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/sentiment", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object/property/toxicity", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape/object/property/face", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape/object/property/burst", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape/object/property/prosody", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape/object/property/language", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape/object/property/ner", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape/object/property/facemesh", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape/object/property/face", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape/object/property/burst", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape/object/property/prosody", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape/object/property/language", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape/object/property/ner", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape/object/property/facemesh", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Ner/shape/object/property/identify_speakers", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/entity", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/position", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/entity_confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/support", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/uri", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/link_word", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/time", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/speaker_confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object/property/emotions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PositionInterval/shape/object/property/begin", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PositionInterval/shape/object/property/end", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape/object/property/grouped_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacePrediction/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacePrediction/shape/object/property/grouped_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape/object/property/grouped_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape/object/property/grouped_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape/object/property/grouped_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape/object/property/metadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape/object/property/grouped_predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Prosody/shape/object/property/granularity", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Prosody/shape/object/property/window", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Prosody/shape/object/property/identify_speakers", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction/shape/object/property/text", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction/shape/object/property/time", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction/shape/object/property/confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction/shape/object/property/speaker_confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction/shape/object/property/emotions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Queued/shape/object/property/created_timestamp_ms", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:RegistryFileDetail/shape/object/property/file_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:RegistryFileDetail/shape/object/property/file_url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SentimentScore/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SentimentScore/shape/object/property/score", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortBy/shape/enum/value/created", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortBy/shape/enum/value/started", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortBy/shape/enum/value/ended", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Url/shape/object/property/url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Status/shape/enum/value/QUEUED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Status/shape/enum/value/IN_PROGRESS", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Status/shape/enum/value/COMPLETED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Status/shape/enum/value/FAILED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferencePrediction/shape/object/property/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferencePrediction/shape/object/property/file_type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferencePrediction/shape/object/property/custom_models", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceResults/shape/object/property/predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceResults/shape/object/property/errors", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceSourcePredictResult/shape/object/property/source", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceSourcePredictResult/shape/object/property/results", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceSourcePredictResult/shape/object/property/error", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Tag/shape/object/property/key", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Tag/shape/object/property/value", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Target/shape/undiscriminatedUnion/variant/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Target/shape/undiscriminatedUnion/variant/1", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Target/shape/undiscriminatedUnion/variant/2", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TimeInterval/shape/object/property/begin", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TimeInterval/shape/object/property/end", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest/shape/object/property/custom_model", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest/shape/object/property/urls", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest/shape/object/property/registry_files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest/shape/object/property/callback_url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest/shape/object/property/notify", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModel/shape/undiscriminatedUnion/variant/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModel/shape/undiscriminatedUnion/variant/1", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelId/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelVersionId/shape/object/property/version_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ToxicityScore/shape/object/property/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ToxicityScore/shape/object/property/score", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/custom_model", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/dataset", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/target_feature", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/task", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/evaluation", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/alternatives", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/callback_url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object/property/notify", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingCustomModel/shape/object/property/id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingCustomModel/shape/object/property/version_id", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Transcription/shape/object/property/language", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Transcription/shape/object/property/identify_speakers", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Transcription/shape/object/property/confidence_threshold", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TranscriptionMetadata/shape/object/property/confidence", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TranscriptionMetadata/shape/object/property/detected_language", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Type/shape/enum/value/EMBEDDING_GENERATION", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Type/shape/enum/value/INFERENCE", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Type/shape/enum/value/TL_INFERENCE", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Type/shape/enum/value/TRAINING", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionPredictResult/shape/undiscriminatedUnion/variant/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionPredictResult/shape/undiscriminatedUnion/variant/1", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ValidationArgs/shape/object/property/positive_label", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:When/shape/enum/value/created_before", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:When/shape/enum/value/created_after", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Window/shape/object/property/length", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Window/shape/object/property/step", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.create-files/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.create-files/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.update-file-name/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset-version/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-details/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-name/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-version/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-description/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-description/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-training-job/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-training-job/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-custom-models-inference-job/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-custom-models-inference-job/response", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Unit/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Alternative/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Classification/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Null/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Regression/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Source/shape/discriminatedUnion/variant/url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Source/shape/discriminatedUnion/variant/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Source/shape/discriminatedUnion/variant/text", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceFile/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceTextSource/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceUrl/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/QUEUED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/IN_PROGRESS", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/COMPLETED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/FAILED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationCompletedEmbeddingGeneration/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationFailed/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationInProgress/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationQueued/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInference/shape/discriminatedUnion/variant/QUEUED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInference/shape/discriminatedUnion/variant/IN_PROGRESS", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInference/shape/discriminatedUnion/variant/COMPLETED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInference/shape/discriminatedUnion/variant/FAILED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceCompletedInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceFailed/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceInProgress/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceQueued/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/QUEUED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/IN_PROGRESS", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/COMPLETED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/FAILED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceCompletedTlInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceFailed/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceInProgress/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceQueued/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/QUEUED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/IN_PROGRESS", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/COMPLETED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/FAILED", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingCompletedTraining/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingFailed/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingInProgress/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingQueued/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Task/shape/discriminatedUnion/variant/classification", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Task/shape/discriminatedUnion/variant/regression", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TaskClassification/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TaskRegression/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TextSource/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Unconfigurable/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/EMBEDDING_GENERATION", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/INFERENCE", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/TL_INFERENCE", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/TRAINING", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobEmbeddingGeneration/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobTlInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobTraining/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/request/formdata/field/file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/request/formdata/field/attributes", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request/formdata/field/name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request/formdata/field/feature_types", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request/formdata/field/labels_file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/request/formdata/field/feature_types", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/request/formdata/field/labels_file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AttributeFilter/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileInput/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributesInput/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributes/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInput/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionTag/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortObject/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JsonObject/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BoundingBox/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BurstPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedEmbeddingGeneration/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelRequest/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetId/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionId/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DescriptionsScore/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmbeddingGenerationBaseRequest/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmotionScore/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Error/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EvaluationArgs/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacemeshPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacsScore/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Failed/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:File/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsBurstPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsLanguagePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsNerPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsProsodyPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InProgress/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferencePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceResults/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceSourcePredictResult/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobEmbeddingGeneration/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTlInference/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTraining/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobId/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Language/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Ner/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PositionInterval/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Prosody/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Queued/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:RegistryFileDetail/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SentimentScore/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Url/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferencePrediction/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceResults/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceSourcePredictResult/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Tag/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TimeInterval/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelId/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelVersionId/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ToxicityScore/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingCustomModel/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Transcription/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TranscriptionMetadata/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ValidationArgs/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Window/shape/object", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Unit", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionFeatureTypesValue/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInputFeatureTypesValue/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Alternative", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Classification", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Dataset/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Direction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Granularity/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Null", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Regression", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortBy/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Status/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Target/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TextSource", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModel/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Type/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Unconfigurable", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionPredictResult/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:When/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.create-files/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.delete-file/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.update-file-name/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file-predictions/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.delete-dataset/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset-version/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-details/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-name/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-version/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-description/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-training-job/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-custom-models-inference-job/example/0", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceFile/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceTextSource/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceUrl/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationCompletedEmbeddingGeneration/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationFailed/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationInProgress/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationQueued/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceCompletedInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceFailed/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceInProgress/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceQueued/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceCompletedTlInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceFailed/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceInProgress/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceQueued/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingCompletedTraining/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingFailed/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingInProgress/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingQueued/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TaskClassification/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TaskRegression/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobEmbeddingGeneration/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobTlInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobTraining/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/request/formdata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request/formdata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/request/formdata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AttributeFilter/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileInput/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributesInput/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributes/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionFeatureTypesValue", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInputFeatureTypesValue", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInput/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionFileType", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionTag/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortObject/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JsonObject/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Bcp47Tag", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BoundingBox/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BurstPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedEmbeddingGeneration/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelRequest/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Dataset", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetId/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionId/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DescriptionsScore/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Direction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmbeddingGenerationBaseRequest/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmotionScore/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Error/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EvaluationArgs/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacemeshPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacsScore/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Failed/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:File/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Granularity", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsBurstPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsLanguagePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsNerPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsProsodyPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InProgress/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferencePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceResults/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceSourcePredictResult/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobEmbeddingGeneration/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTlInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTraining/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobId/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Language/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Ner/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PositionInterval/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Prosody/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Queued/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:RegistryFileDetail/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SentimentScore/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortBy", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Source/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Url/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGeneration/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInference/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTraining/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Status", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferencePrediction/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceResults/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceSourcePredictResult/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Tag/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Target", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Task/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TimeInterval/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModel", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelId/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelVersionId/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ToxicityScore/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingCustomModel/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Transcription/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TranscriptionMetadata/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Type", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJob/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionPredictResult", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ValidationArgs/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:When", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Window/shape", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceFile", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceTextSource", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SourceUrl", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationCompletedEmbeddingGeneration", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationFailed", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationInProgress", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGenerationQueued", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceCompletedInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceFailed", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceInProgress", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInferenceQueued", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceCompletedTlInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceFailed", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceInProgress", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInferenceQueued", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingCompletedTraining", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingFailed", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingInProgress", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTrainingQueued", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TaskClassification", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TaskRegression", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobEmbeddingGeneration", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobTlInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJobJobTraining", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AttributeFilter", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileInput", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributesInput", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:AuthorizedFile", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FileWithAttributes", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersion", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ReturnDataset", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabelsFileUriInput", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModel", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersion", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ExternalModelVersionTag", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelPage", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PageableObject", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SortObject", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JsonObject", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FilePage", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetPage", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionPage", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetLabels", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BoundingBox", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:BurstPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedEmbeddingGeneration", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTlInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CompletedTraining", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelRequest", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetId", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DatasetVersionId", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:DescriptionsScore", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmbeddingGenerationBaseRequest", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EmotionScore", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Error", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:EvaluationArgs", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Face", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacemeshPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:FacsScore", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Failed", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:File", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsBurstPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsFacemeshPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsLanguagePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsNerPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:GroupedPredictionsProsodyPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InProgress", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceBaseRequest", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferencePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceRequest", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceResults", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:InferenceSourcePredictResult", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobEmbeddingGeneration", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTlInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobTraining", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:JobId", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Language", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:LanguagePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Models", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ModelsPredictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Ner", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:NerPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PositionInterval", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullBurstPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalNullFacemeshPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Prosody", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ProsodyPrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Queued", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:RegistryFileDetail", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:SentimentScore", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Source", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Url", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateEmbeddingGeneration", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTlInference", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:StateTraining", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferencePrediction", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceResults", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceSourcePredictResult", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Tag", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Task", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TimeInterval", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TlInferenceBaseRequest", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelId", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:CustomModelVersionId", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ToxicityScore", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingBaseRequest", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TrainingCustomModel", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Transcription", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:TranscriptionMetadata", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:UnionJob", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:ValidationArgs", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/type-definition/type_:Window", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.list-files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.create-files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.delete-file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.update-file-name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.get-file-predictions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-datasets", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version/request", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.delete-dataset", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-versions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.get-dataset-version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.list-dataset-version-files", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-models", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-details", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-name", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.list-model-versions", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.get-model-version", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_models.update-model-description", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-training-job", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_jobs.start-custom-models-inference-job", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_files.upload-file", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset", + "bcb7826e-ffd6-4440-b3de-6bf37440c3e2/endpoint/endpoint_datasets.create-dataset-version" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-e810f56e-df97-4af2-bdaa-659077e1948e.json b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-e810f56e-df97-4af2-bdaa-659077e1948e.json new file mode 100644 index 0000000000..5987741df7 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitionKeys-e810f56e-df97-4af2-bdaa-659077e1948e.json @@ -0,0 +1,858 @@ +[ + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/query/limit", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/query/status", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/query/when", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/query/timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/query/sort_by", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/query/direction", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/query/type", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/example/0/snippet/curl/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/example/0/snippet/typescript/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job/example/0/snippet/curl/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job/example/0/snippet/typescript/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/path/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/example/0/snippet/curl/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/example/0/snippet/typescript/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/example/1/snippet/curl/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/example/1/snippet/typescript/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-predictions/path/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-predictions/example/0/snippet/curl/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-predictions/example/0/snippet/typescript/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-artifacts/path/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-artifacts/example/0/snippet/curl/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-artifacts/example/0/snippet/typescript/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/request/formdata/field/json/property/json", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/request/formdata/field/file/files/file", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/example/0/snippet/curl/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/example/0/snippet/typescript/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/websocket/subpackage_stream.stream/requestHeader/X-Hume-Api-Key", + "e810f56e-df97-4af2-bdaa-659077e1948e/websocket/subpackage_stream.stream/example/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstJobDetails/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurstPredictionsItem/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurstPredictionsItem/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurst/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/frame", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/bbox", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/prob", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/face_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/facs", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object/property/descriptions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFace/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemeshPredictionsItem/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemesh/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem/shape/object/property/text", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem/shape/object/property/position", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem/shape/object/property/sentiment", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem/shape/object/property/toxicity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguage/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsodyPredictionsItem/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsodyPredictionsItem/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsody/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object/property/payload_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object/property/job_details", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object/property/burst", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object/property/face", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object/property/facemesh", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object/property/language", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object/property/prosody", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamErrorJobDetails/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamError/shape/object/property/error", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamError/shape/object/property/code", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamError/shape/object/property/payload_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamError/shape/object/property/job_details", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetailsJobDetails/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetails/shape/object/property/warning", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetails/shape/object/property/code", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetails/shape/object/property/payload_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetails/shape/object/property/job_details", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:SubscribeEvent/shape/undiscriminatedUnion/variant/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:SubscribeEvent/shape/undiscriminatedUnion/variant/1", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:SubscribeEvent/shape/undiscriminatedUnion/variant/2", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape/object/property/facs", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape/object/property/descriptions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape/object/property/identify_faces", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape/object/property/fps_pred", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape/object/property/prob_threshold", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape/object/property/min_face_size", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsLanguage/shape/object/property/sentiment", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsLanguage/shape/object/property/toxicity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsLanguage/shape/object/property/granularity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels/shape/object/property/burst", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels/shape/object/property/face", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels/shape/object/property/facemesh", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels/shape/object/property/language", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels/shape/object/property/prosody", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object/property/data", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object/property/models", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object/property/stream_window_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object/property/reset_stream", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object/property/raw_text", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object/property/job_details", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object/property/payload_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/zh", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/da", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/nl", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/en", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/en-AU", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/en-IN", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/en-NZ", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/en-GB", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/fr", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/fr-CA", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/de", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/hi", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/hi-Latn", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/it", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/ja", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/ko", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/no", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/pl", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/pt", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/pt-BR", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/pt-PT", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/ru", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/es", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/es-419", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/sv", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/ta", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/tr", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape/enum/value/uk", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BoundingBox/shape/object/property/x", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BoundingBox/shape/object/property/y", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BoundingBox/shape/object/property/w", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BoundingBox/shape/object/property/h", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BurstPrediction/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BurstPrediction/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BurstPrediction/shape/object/property/descriptions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedEmbeddingGeneration/shape/object/property/created_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedEmbeddingGeneration/shape/object/property/started_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedEmbeddingGeneration/shape/object/property/ended_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference/shape/object/property/created_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference/shape/object/property/started_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference/shape/object/property/ended_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference/shape/object/property/num_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference/shape/object/property/num_errors", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference/shape/object/property/created_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference/shape/object/property/started_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference/shape/object/property/ended_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference/shape/object/property/num_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference/shape/object/property/num_errors", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining/shape/object/property/created_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining/shape/object/property/started_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining/shape/object/property/ended_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining/shape/object/property/custom_model", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining/shape/object/property/alternatives", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelPrediction/shape/object/property/output", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelPrediction/shape/object/property/error", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelPrediction/shape/object/property/task_type", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelRequest/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelRequest/shape/object/property/description", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelRequest/shape/object/property/tags", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Dataset/shape/undiscriminatedUnion/variant/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Dataset/shape/undiscriminatedUnion/variant/1", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetId/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetVersionId/shape/object/property/version_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DescriptionsScore/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DescriptionsScore/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Direction/shape/enum/value/asc", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Direction/shape/enum/value/desc", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmbeddingGenerationBaseRequest/shape/object/property/registry_file_details", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionScore/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionScore/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Error/shape/object/property/message", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Error/shape/object/property/file", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EvaluationArgs/shape/object/property/validation", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object/property/fps_pred", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object/property/prob_threshold", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object/property/identify_faces", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object/property/min_face_size", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object/property/facs", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object/property/descriptions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object/property/save_faces", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object/property/frame", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object/property/prob", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object/property/box", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object/property/facs", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object/property/descriptions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacemeshPrediction/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacsScore/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacsScore/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Failed/shape/object/property/created_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Failed/shape/object/property/started_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Failed/shape/object/property/ended_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Failed/shape/object/property/message", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:File/shape/object/property/filename", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:File/shape/object/property/content_type", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:File/shape/object/property/md5sum", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Granularity/shape/enum/value/word", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Granularity/shape/enum/value/sentence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Granularity/shape/enum/value/utterance", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Granularity/shape/enum/value/conversational_turn", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsBurstPrediction/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsBurstPrediction/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacePrediction/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacePrediction/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsLanguagePrediction/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsLanguagePrediction/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsNerPrediction/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsNerPrediction/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsProsodyPrediction/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsProsodyPrediction/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InProgress/shape/object/property/created_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InProgress/shape/object/property/started_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object/property/models", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object/property/transcription", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object/property/urls", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object/property/registry_files", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object/property/text", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object/property/callback_url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object/property/notify", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferencePrediction/shape/object/property/file", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferencePrediction/shape/object/property/models", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/models", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/transcription", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/urls", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/registry_files", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/text", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/callback_url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/notify", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object/property/files", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceResults/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceResults/shape/object/property/errors", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceSourcePredictResult/shape/object/property/source", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceSourcePredictResult/shape/object/property/results", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceSourcePredictResult/shape/object/property/error", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobEmbeddingGeneration/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobEmbeddingGeneration/shape/object/property/user_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobEmbeddingGeneration/shape/object/property/request", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobEmbeddingGeneration/shape/object/property/state", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobInference/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobInference/shape/object/property/user_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobInference/shape/object/property/request", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobInference/shape/object/property/state", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTlInference/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTlInference/shape/object/property/user_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTlInference/shape/object/property/request", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTlInference/shape/object/property/state", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTraining/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTraining/shape/object/property/user_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTraining/shape/object/property/request", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTraining/shape/object/property/state", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobId/shape/object/property/job_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Language/shape/object/property/granularity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Language/shape/object/property/sentiment", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Language/shape/object/property/toxicity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Language/shape/object/property/identify_speakers", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/text", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/position", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/speaker_confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/sentiment", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object/property/toxicity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape/object/property/face", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape/object/property/burst", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape/object/property/prosody", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape/object/property/language", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape/object/property/ner", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape/object/property/facemesh", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape/object/property/face", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape/object/property/burst", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape/object/property/prosody", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape/object/property/language", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape/object/property/ner", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape/object/property/facemesh", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Ner/shape/object/property/identify_speakers", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/entity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/position", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/entity_confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/support", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/uri", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/link_word", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/speaker_confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PositionInterval/shape/object/property/begin", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PositionInterval/shape/object/property/end", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape/object/property/metadata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape/object/property/grouped_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacePrediction/shape/object/property/metadata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacePrediction/shape/object/property/grouped_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape/object/property/metadata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape/object/property/grouped_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape/object/property/metadata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape/object/property/grouped_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape/object/property/metadata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape/object/property/grouped_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape/object/property/metadata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape/object/property/grouped_predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Prosody/shape/object/property/granularity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Prosody/shape/object/property/window", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Prosody/shape/object/property/identify_speakers", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction/shape/object/property/text", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction/shape/object/property/time", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction/shape/object/property/confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction/shape/object/property/speaker_confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction/shape/object/property/emotions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Queued/shape/object/property/created_timestamp_ms", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:RegistryFileDetail/shape/object/property/file_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:RegistryFileDetail/shape/object/property/file_url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentScore/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentScore/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SortBy/shape/enum/value/created", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SortBy/shape/enum/value/started", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SortBy/shape/enum/value/ended", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Url/shape/object/property/url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Status/shape/enum/value/QUEUED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Status/shape/enum/value/IN_PROGRESS", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Status/shape/enum/value/COMPLETED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Status/shape/enum/value/FAILED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferencePrediction/shape/object/property/file", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferencePrediction/shape/object/property/file_type", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferencePrediction/shape/object/property/custom_models", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceResults/shape/object/property/predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceResults/shape/object/property/errors", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceSourcePredictResult/shape/object/property/source", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceSourcePredictResult/shape/object/property/results", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceSourcePredictResult/shape/object/property/error", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Tag/shape/object/property/key", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Tag/shape/object/property/value", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Target/shape/undiscriminatedUnion/variant/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Target/shape/undiscriminatedUnion/variant/1", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Target/shape/undiscriminatedUnion/variant/2", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeInterval/shape/object/property/begin", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeInterval/shape/object/property/end", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest/shape/object/property/custom_model", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest/shape/object/property/urls", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest/shape/object/property/registry_files", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest/shape/object/property/callback_url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest/shape/object/property/notify", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModel/shape/undiscriminatedUnion/variant/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModel/shape/undiscriminatedUnion/variant/1", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelId/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelVersionId/shape/object/property/version_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityScore/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityScore/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/custom_model", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/dataset", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/target_feature", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/task", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/evaluation", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/alternatives", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/callback_url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object/property/notify", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingCustomModel/shape/object/property/id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingCustomModel/shape/object/property/version_id", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Transcription/shape/object/property/language", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Transcription/shape/object/property/identify_speakers", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Transcription/shape/object/property/confidence_threshold", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TranscriptionMetadata/shape/object/property/confidence", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TranscriptionMetadata/shape/object/property/detected_language", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Type/shape/enum/value/EMBEDDING_GENERATION", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Type/shape/enum/value/INFERENCE", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Type/shape/enum/value/TL_INFERENCE", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Type/shape/enum/value/TRAINING", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionPredictResult/shape/undiscriminatedUnion/variant/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionPredictResult/shape/undiscriminatedUnion/variant/1", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ValidationArgs/shape/object/property/positive_label", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:When/shape/enum/value/created_before", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:When/shape/enum/value/created_after", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Window/shape/object/property/length", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Window/shape/object/property/step", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionEmbeddingItem/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionEmbeddingItem/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeRange/shape/object/property/begin", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeRange/shape/object/property/end", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TextPosition/shape/object/property/begin", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TextPosition/shape/object/property/end", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentItem/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentItem/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityItem/shape/object/property/name", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityItem/shape/object/property/score", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/response", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job/request", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job/response", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/response", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-predictions/response", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-artifacts/response", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/response", + "e810f56e-df97-4af2-bdaa-659077e1948e/websocket/subpackage_stream.stream/message/server/subscribe/body", + "e810f56e-df97-4af2-bdaa-659077e1948e/websocket/subpackage_stream.stream/message/client/publish/body", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Alternative/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Classification/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Null/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Regression/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Source/shape/discriminatedUnion/variant/url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Source/shape/discriminatedUnion/variant/file", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Source/shape/discriminatedUnion/variant/text", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceFile/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceTextSource/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceUrl/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/QUEUED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/IN_PROGRESS", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/COMPLETED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGeneration/shape/discriminatedUnion/variant/FAILED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationCompletedEmbeddingGeneration/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationFailed/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationInProgress/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationQueued/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInference/shape/discriminatedUnion/variant/QUEUED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInference/shape/discriminatedUnion/variant/IN_PROGRESS", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInference/shape/discriminatedUnion/variant/COMPLETED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInference/shape/discriminatedUnion/variant/FAILED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceCompletedInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceFailed/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceInProgress/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceQueued/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/QUEUED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/IN_PROGRESS", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/COMPLETED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInference/shape/discriminatedUnion/variant/FAILED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceCompletedTlInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceFailed/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceInProgress/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceQueued/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/QUEUED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/IN_PROGRESS", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/COMPLETED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTraining/shape/discriminatedUnion/variant/FAILED", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingCompletedTraining/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingFailed/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingInProgress/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingQueued/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Task/shape/discriminatedUnion/variant/classification", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Task/shape/discriminatedUnion/variant/regression", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TaskClassification/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TaskRegression/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TextSource/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Unconfigurable/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/EMBEDDING_GENERATION", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/INFERENCE", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/TL_INFERENCE", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJob/shape/discriminatedUnion/variant/TRAINING", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobEmbeddingGeneration/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobTlInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobTraining/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionEmbedding/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Sentiment/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Toxicity/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/request/formdata/field/json", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/request/formdata/field/file", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstJobDetails/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurstPredictionsItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurst/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFace/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemeshPredictionsItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemesh/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguage/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsodyPredictionsItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsody/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamErrorJobDetails/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamError/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetailsJobDetails/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetails/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsLanguage/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BoundingBox/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BurstPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedEmbeddingGeneration/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelRequest/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetId/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetVersionId/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DescriptionsScore/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmbeddingGenerationBaseRequest/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionScore/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Error/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EvaluationArgs/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacemeshPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacsScore/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Failed/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:File/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsBurstPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsLanguagePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsNerPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsProsodyPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InProgress/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferencePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceResults/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceSourcePredictResult/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobEmbeddingGeneration/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTlInference/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTraining/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobId/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Language/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Ner/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PositionInterval/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Prosody/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Queued/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:RegistryFileDetail/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentScore/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Url/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferencePrediction/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceResults/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceSourcePredictResult/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Tag/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeInterval/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelId/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelVersionId/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityScore/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingCustomModel/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Transcription/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TranscriptionMetadata/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ValidationArgs/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Window/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionEmbeddingItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeRange/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TextPosition/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityItem/shape/object", + "e810f56e-df97-4af2-bdaa-659077e1948e/websocket/subpackage_stream.stream/message/server/subscribe", + "e810f56e-df97-4af2-bdaa-659077e1948e/websocket/subpackage_stream.stream/message/client/publish", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:SubscribeEvent/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Alternative", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Classification", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Dataset/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Direction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Granularity/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Null", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Regression", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SortBy/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Status/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Target/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TextSource", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModel/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Type/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Unconfigurable", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionPredictResult/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:When/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionEmbedding", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Sentiment", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Toxicity", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs/example/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job/example/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/example/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details/example/1", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-predictions/example/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-artifacts/example/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/example/0", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceFile/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceTextSource/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceUrl/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationCompletedEmbeddingGeneration/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationFailed/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationInProgress/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationQueued/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceCompletedInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceFailed/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceInProgress/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceQueued/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceCompletedTlInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceFailed/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceInProgress/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceQueued/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingCompletedTraining/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingFailed/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingInProgress/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingQueued/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TaskClassification/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TaskRegression/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobEmbeddingGeneration/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobTlInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobTraining/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/request/formdata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstJobDetails/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurstPredictionsItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurst/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFace/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemeshPredictionsItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemesh/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguage/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsodyPredictionsItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsody/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamErrorJobDetails/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamError/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetailsJobDetails/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetails/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:SubscribeEvent", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsLanguage/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Bcp47Tag", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BoundingBox/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BurstPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedEmbeddingGeneration/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelRequest/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Dataset", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetId/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetVersionId/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DescriptionsScore/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Direction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmbeddingGenerationBaseRequest/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionScore/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Error/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EvaluationArgs/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacemeshPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacsScore/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Failed/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:File/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Granularity", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsBurstPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacemeshPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsLanguagePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsNerPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsProsodyPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InProgress/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferencePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceResults/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceSourcePredictResult/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobEmbeddingGeneration/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTlInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTraining/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobId/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Language/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Ner/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PositionInterval/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullBurstPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacemeshPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Prosody/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Queued/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:RegistryFileDetail/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentScore/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SortBy", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Source/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Url/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGeneration/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInference/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTraining/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Status", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferencePrediction/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceResults/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceSourcePredictResult/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Tag/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Target", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Task/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeInterval/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModel", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelId/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelVersionId/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityScore/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingCustomModel/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Transcription/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TranscriptionMetadata/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Type", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJob/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionPredictResult", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ValidationArgs/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:When", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Window/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionEmbeddingItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeRange/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TextPosition/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityItem/shape", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceFile", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceTextSource", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SourceUrl", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationCompletedEmbeddingGeneration", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationFailed", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationInProgress", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGenerationQueued", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceCompletedInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceFailed", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceInProgress", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInferenceQueued", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceCompletedTlInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceFailed", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceInProgress", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInferenceQueued", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingCompletedTraining", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingFailed", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingInProgress", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTrainingQueued", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TaskClassification", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TaskRegression", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobEmbeddingGeneration", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobTlInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJobJobTraining", + "e810f56e-df97-4af2-bdaa-659077e1948e/websocket/subpackage_stream.stream", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstJobDetails", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurstPredictionsItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstBurst", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacePredictionsItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFace", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemeshPredictionsItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstFacemesh", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguagePredictionsItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstLanguage", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsodyPredictionsItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurstProsody", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamBurst", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamErrorJobDetails", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamError", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetailsJobDetails", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamJobDetails", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsFace", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModelsLanguage", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamDataModels", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_stream:StreamData", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BoundingBox", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:BurstPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedEmbeddingGeneration", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTlInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CompletedTraining", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelRequest", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetId", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DatasetVersionId", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:DescriptionsScore", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmbeddingGenerationBaseRequest", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionScore", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Error", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EvaluationArgs", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Face", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacemeshPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:FacsScore", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Failed", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:File", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsBurstPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsFacemeshPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsLanguagePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsNerPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:GroupedPredictionsProsodyPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InProgress", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceBaseRequest", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferencePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceRequest", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceResults", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:InferenceSourcePredictResult", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobEmbeddingGeneration", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTlInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobTraining", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:JobId", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Language", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:LanguagePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Models", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ModelsPredictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Ner", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:NerPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PositionInterval", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullBurstPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalNullFacemeshPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataNerPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Prosody", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ProsodyPrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Queued", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:RegistryFileDetail", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentScore", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Source", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Url", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateEmbeddingGeneration", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTlInference", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:StateTraining", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferencePrediction", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceResults", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceSourcePredictResult", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Tag", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Task", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeInterval", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TlInferenceBaseRequest", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelId", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:CustomModelVersionId", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityScore", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingBaseRequest", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TrainingCustomModel", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Transcription", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TranscriptionMetadata", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:UnionJob", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ValidationArgs", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:Window", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:EmotionEmbeddingItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TimeRange", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:TextPosition", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:SentimentItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/type-definition/type_:ToxicityItem", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.list-jobs", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-details", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-predictions", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.get-job-artifacts", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file/request", + "e810f56e-df97-4af2-bdaa-659077e1948e/endpoint/endpoint_batch.start-inference-job-from-local-file" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/hume/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitions.json new file mode 100644 index 0000000000..2229a30135 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/hume/apiDefinitions.json @@ -0,0 +1,22417 @@ +[ + { + "id": "e810f56e-df97-4af2-bdaa-659077e1948e", + "endpoints": { + "endpoint_batch.list-jobs": { + "id": "endpoint_batch.list-jobs", + "namespace": [ + "subpackage_batch" + ], + "description": "Sort and filter jobs.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/batch/jobs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of jobs to include in the response." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Status" + } + }, + "description": "Include only jobs with these statuses." + }, + { + "key": "when", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:When" + } + }, + "description": "Include only jobs that were created before or after `timestamp_ms`." + }, + { + "key": "timestamp_ms", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Defaults to the current date and time. See `when`." + }, + { + "key": "sort_by", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortBy" + } + }, + "description": "The job timestamp to sort by." + }, + { + "key": "direction", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Direction" + } + }, + "description": "The sort direction." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Type" + } + }, + "description": "Include only jobs of these types." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:UnionJob" + } + } + } + }, + "examples": [ + { + "path": "/v0/batch/jobs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "type": "INFERENCE", + "job_id": "job_id", + "request": { + "files": [ + { + "md5sum": "md5sum", + "filename": "filename", + "content_type": "content_type" + } + ], + "models": { + "face": { + "fps_pred": 3, + "prob_threshold": 0.99, + "identify_faces": false, + "min_face_size": 60, + "facs": null, + "descriptions": null, + "save_faces": false + }, + "burst": {}, + "prosody": { + "granularity": "utterance", + "window": null, + "identify_speakers": false + }, + "language": { + "granularity": "word", + "sentiment": null, + "toxicity": null, + "identify_speakers": false + }, + "ner": { + "identify_speakers": false + }, + "facemesh": {} + }, + "urls": [ + "https://hume-tutorials.s3.amazonaws.com/faces.zip" + ], + "registry_files": [], + "text": [], + "callback_url": null, + "notify": true + }, + "state": { + "status": "COMPLETED", + "created_timestamp_ms": 1712587158717, + "ended_timestamp_ms": 1712587159274, + "num_errors": 0, + "num_predictions": 10, + "started_timestamp_ms": 1712587158800 + }, + "user_id": "user_id" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/batch/jobs \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.expressionMeasurement.batch.listJobs();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_batch.start-inference-job": { + "id": "endpoint_batch.start-inference-job", + "namespace": [ + "subpackage_batch" + ], + "description": "Start a new measurement inference job.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/batch/jobs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:InferenceBaseRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:JobId" + } + } + }, + "examples": [ + { + "path": "/v0/batch/jobs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "urls": [ + "https://hume-tutorials.s3.amazonaws.com/faces.zip" + ], + "notify": true + } + }, + "responseBody": { + "type": "json", + "value": { + "job_id": "job_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/batch/jobs \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"urls\": [\n \"https://hume-tutorials.s3.amazonaws.com/faces.zip\"\n ],\n \"notify\": true\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.expressionMeasurement.batch.startInferenceJob({\n urls: [\"https://hume-tutorials.s3.amazonaws.com/faces.zip\"],\n notify: true\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_batch.get-job-details": { + "id": "endpoint_batch.get-job-details", + "namespace": [ + "subpackage_batch" + ], + "description": "Get the request details and state of a given job.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/batch/jobs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UnionJob" + } + } + }, + "examples": [ + { + "path": "/v0/batch/jobs/job_id", + "responseStatusCode": 200, + "name": "Embedding Generation", + "pathParameters": { + "id": "job_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "type": "EMBEDDING_GENERATION", + "job_id": "string", + "request": { + "registry_file_details": [ + { + "file_id": "string", + "file_url": "string" + } + ] + }, + "state": { + "status": "QUEUED", + "created_timestamp_ms": 0 + }, + "user_id": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/batch/jobs/job_id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.expressionMeasurement.batch.getJobDetails(\"job_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/v0/batch/jobs/job_id", + "responseStatusCode": 200, + "name": "Inference", + "pathParameters": { + "id": "job_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "type": "INFERENCE", + "job_id": "job_id", + "request": { + "files": [], + "models": { + "face": { + "fps_pred": 3, + "prob_threshold": 0.99, + "identify_faces": false, + "min_face_size": 60, + "facs": null, + "descriptions": null, + "save_faces": false + }, + "burst": {}, + "prosody": { + "granularity": "utterance", + "window": null, + "identify_speakers": false + }, + "language": { + "granularity": "word", + "sentiment": null, + "toxicity": null, + "identify_speakers": false + }, + "ner": { + "identify_speakers": false + }, + "facemesh": {} + }, + "urls": [ + "https://hume-tutorials.s3.amazonaws.com/faces.zip" + ], + "registry_files": [], + "text": [], + "callback_url": null, + "notify": true + }, + "state": { + "status": "COMPLETED", + "created_timestamp_ms": 1712590457884, + "ended_timestamp_ms": 1712590462252, + "num_errors": 0, + "num_predictions": 10, + "started_timestamp_ms": 1712590457995 + }, + "user_id": "user_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/batch/jobs/job_id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.expressionMeasurement.batch.getJobDetails(\"job_id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_batch.get-job-predictions": { + "id": "endpoint_batch.get-job-predictions", + "namespace": [ + "subpackage_batch" + ], + "description": "Get the JSON predictions of a completed measurement or custom models inference job.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/batch/jobs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/predictions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:UnionPredictResult" + } + } + } + }, + "examples": [ + { + "path": "/v0/batch/jobs/job_id/predictions", + "responseStatusCode": 200, + "pathParameters": { + "id": "job_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "source": { + "type": "url", + "url": "https://hume-tutorials.s3.amazonaws.com/faces.zip" + }, + "results": { + "predictions": [ + { + "file": "faces/100.jpg", + "models": { + "face": { + "metadata": null, + "grouped_predictions": [ + { + "id": "unknown", + "predictions": [ + { + "frame": 0, + "time": 0, + "prob": 0.9994111061096191, + "box": { + "x": 1187.885986328125, + "y": 1397.697509765625, + "w": 1401.668701171875, + "h": 1961.424560546875 + }, + "emotions": [ + { + "name": "Admiration", + "score": 0.10722749680280685 + }, + { + "name": "Adoration", + "score": 0.06395940482616425 + }, + { + "name": "Aesthetic Appreciation", + "score": 0.05811462551355362 + }, + { + "name": "Amusement", + "score": 0.14187128841876984 + }, + { + "name": "Anger", + "score": 0.02804684266448021 + }, + { + "name": "Anxiety", + "score": 0.2713485360145569 + }, + { + "name": "Awe", + "score": 0.33812594413757324 + }, + { + "name": "Awkwardness", + "score": 0.1745193600654602 + }, + { + "name": "Boredom", + "score": 0.23600080609321594 + }, + { + "name": "Calmness", + "score": 0.18988418579101562 + }, + { + "name": "Concentration", + "score": 0.44288986921310425 + }, + { + "name": "Confusion", + "score": 0.39346569776535034 + }, + { + "name": "Contemplation", + "score": 0.31002455949783325 + }, + { + "name": "Contempt", + "score": 0.048870109021663666 + }, + { + "name": "Contentment", + "score": 0.0579497292637825 + }, + { + "name": "Craving", + "score": 0.06544201076030731 + }, + { + "name": "Desire", + "score": 0.05526508390903473 + }, + { + "name": "Determination", + "score": 0.08590991795063019 + }, + { + "name": "Disappointment", + "score": 0.19508258998394012 + }, + { + "name": "Disgust", + "score": 0.031529419124126434 + }, + { + "name": "Distress", + "score": 0.23210826516151428 + }, + { + "name": "Doubt", + "score": 0.3284550905227661 + }, + { + "name": "Ecstasy", + "score": 0.040716782212257385 + }, + { + "name": "Embarrassment", + "score": 0.1467227339744568 + }, + { + "name": "Empathic Pain", + "score": 0.07633581757545471 + }, + { + "name": "Entrancement", + "score": 0.16245244443416595 + }, + { + "name": "Envy", + "score": 0.03267110139131546 + }, + { + "name": "Excitement", + "score": 0.10656816512346268 + }, + { + "name": "Fear", + "score": 0.3115977346897125 + }, + { + "name": "Guilt", + "score": 0.11615975946187973 + }, + { + "name": "Horror", + "score": 0.19795553386211395 + }, + { + "name": "Interest", + "score": 0.3136432468891144 + }, + { + "name": "Joy", + "score": 0.06285581737756729 + }, + { + "name": "Love", + "score": 0.06339752674102783 + }, + { + "name": "Nostalgia", + "score": 0.05866732448339462 + }, + { + "name": "Pain", + "score": 0.07684041559696198 + }, + { + "name": "Pride", + "score": 0.026822954416275024 + }, + { + "name": "Realization", + "score": 0.30000734329223633 + }, + { + "name": "Relief", + "score": 0.04414166510105133 + }, + { + "name": "Romance", + "score": 0.042728863656520844 + }, + { + "name": "Sadness", + "score": 0.14773206412792206 + }, + { + "name": "Satisfaction", + "score": 0.05902980640530586 + }, + { + "name": "Shame", + "score": 0.08103451132774353 + }, + { + "name": "Surprise (negative)", + "score": 0.25518184900283813 + }, + { + "name": "Surprise (positive)", + "score": 0.28845661878585815 + }, + { + "name": "Sympathy", + "score": 0.062488824129104614 + }, + { + "name": "Tiredness", + "score": 0.1559651643037796 + }, + { + "name": "Triumph", + "score": 0.01955239288508892 + } + ], + "facs": null, + "descriptions": null + } + ] + } + ] + } + } + } + ], + "errors": [] + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/batch/jobs/job_id/predictions \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.expressionMeasurement.batch.getJobPredictions(\"job_id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_batch.get-job-artifacts": { + "id": "endpoint_batch.get-job-artifacts", + "namespace": [ + "subpackage_batch" + ], + "description": "Get the artifacts ZIP of a completed measurement or custom models inference job.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/batch/jobs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/artifacts" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "fileDownload" + } + }, + "examples": [ + { + "path": "/v0/batch/jobs/:id/artifacts", + "responseStatusCode": 200, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "filename", + "value": "" + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/batch/jobs/:id/artifacts \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.expressionMeasurement.batch.getJobArtifacts(\"string\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_batch.start-inference-job-from-local-file": { + "id": "endpoint_batch.start-inference-job-from-local-file", + "namespace": [ + "subpackage_batch" + ], + "description": "Start a new batch inference job.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/batch/jobs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "formData", + "fields": [ + { + "type": "property", + "key": "json", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:InferenceBaseRequest" + } + } + }, + { + "type": "files", + "key": "file", + "isOptional": false + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:JobId" + } + } + }, + "examples": [ + { + "path": "/v0/batch/jobs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "form", + "value": { + "json": { + "type": "json" + }, + "file": { + "type": "filenames", + "value": [] + } + } + }, + "responseBody": { + "type": "json", + "value": { + "job_id": "job_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/batch/jobs \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.expressionMeasurement.batch.startInferenceJob({\n urls: [\"https://hume-tutorials.s3.amazonaws.com/faces.zip\"],\n notify: true\n});\n", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": { + "subpackage_stream.stream": { + "id": "subpackage_stream.stream", + "namespace": [ + "subpackage_stream" + ], + "path": [ + { + "type": "literal", + "value": "/v0/stream/models" + } + ], + "messages": [ + { + "type": "subscribe", + "origin": "server", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_stream:SubscribeEvent" + } + } + }, + { + "type": "publish", + "origin": "client", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_stream:StreamData" + } + } + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "wss://api.hume.ai" + } + ], + "requestHeaders": [ + { + "key": "X-Hume-Api-Key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "examples": [ + { + "path": "/v0/stream/models", + "pathParameters": {}, + "queryParameters": {}, + "requestHeaders": {}, + "messages": [ + { + "type": "publish", + "body": {} + }, + { + "type": "subscribe", + "body": {} + } + ] + } + ] + } + }, + "webhooks": {}, + "types": { + "type_stream:StreamBurstJobDetails": { + "name": "StreamBurstJobDetails", + "description": "If the job_details flag was set in the request, details about the current streaming job will be returned in the response body.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the current streaming job." + } + ] + } + }, + "type_stream:StreamBurstBurstPredictionsItem": { + "name": "StreamBurstBurstPredictionsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "time", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TimeRange" + } + } + }, + { + "key": "emotions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EmotionEmbedding" + } + } + } + ] + } + }, + "type_stream:StreamBurstBurst": { + "name": "StreamBurstBurst", + "description": "Response for the vocal burst emotion model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_stream:StreamBurstBurstPredictionsItem" + } + } + } + } + ] + } + }, + "type_stream:StreamBurstFacePredictionsItem": { + "name": "StreamBurstFacePredictionsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "frame", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Frame number" + }, + { + "key": "time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Time in seconds when face detection occurred." + }, + { + "key": "bbox", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BoundingBox" + } + } + }, + { + "key": "prob", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The predicted probability that a detected face was actually a face." + }, + { + "key": "face_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for a face. Not that this defaults to `unknown` unless face identification is enabled in the face model configuration." + }, + { + "key": "emotions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EmotionEmbedding" + } + } + }, + { + "key": "facs", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EmotionEmbedding" + } + } + }, + { + "key": "descriptions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EmotionEmbedding" + } + } + } + ] + } + }, + "type_stream:StreamBurstFace": { + "name": "StreamBurstFace", + "description": "Response for the facial expression emotion model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_stream:StreamBurstFacePredictionsItem" + } + } + } + } + ] + } + }, + "type_stream:StreamBurstFacemeshPredictionsItem": { + "name": "StreamBurstFacemeshPredictionsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emotions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EmotionEmbedding" + } + } + } + ] + } + }, + "type_stream:StreamBurstFacemesh": { + "name": "StreamBurstFacemesh", + "description": "Response for the facemesh emotion model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_stream:StreamBurstFacemeshPredictionsItem" + } + } + } + } + ] + } + }, + "type_stream:StreamBurstLanguagePredictionsItem": { + "name": "StreamBurstLanguagePredictionsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A segment of text (like a word or a sentence)." + }, + { + "key": "position", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TextPosition" + } + } + }, + { + "key": "emotions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EmotionEmbedding" + } + } + }, + { + "key": "sentiment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Sentiment" + } + } + }, + { + "key": "toxicity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Toxicity" + } + } + } + ] + } + }, + "type_stream:StreamBurstLanguage": { + "name": "StreamBurstLanguage", + "description": "Response for the language emotion model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_stream:StreamBurstLanguagePredictionsItem" + } + } + } + } + ] + } + }, + "type_stream:StreamBurstProsodyPredictionsItem": { + "name": "StreamBurstProsodyPredictionsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "time", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TimeRange" + } + } + }, + { + "key": "emotions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EmotionEmbedding" + } + } + } + ] + } + }, + "type_stream:StreamBurstProsody": { + "name": "StreamBurstProsody", + "description": "Response for the speech prosody emotion model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_stream:StreamBurstProsodyPredictionsItem" + } + } + } + } + ] + } + }, + "type_stream:StreamBurst": { + "name": "StreamBurst", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "payload_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If a payload ID was passed in the request, the same payload ID will be sent back in the response body." + }, + { + "key": "job_details", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamBurstJobDetails" + } + }, + "description": "If the job_details flag was set in the request, details about the current streaming job will be returned in the response body." + }, + { + "key": "burst", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamBurstBurst" + } + }, + "description": "Response for the vocal burst emotion model." + }, + { + "key": "face", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamBurstFace" + } + }, + "description": "Response for the facial expression emotion model." + }, + { + "key": "facemesh", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamBurstFacemesh" + } + }, + "description": "Response for the facemesh emotion model." + }, + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamBurstLanguage" + } + }, + "description": "Response for the language emotion model." + }, + { + "key": "prosody", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamBurstProsody" + } + }, + "description": "Response for the speech prosody emotion model." + } + ] + } + }, + "type_stream:StreamErrorJobDetails": { + "name": "StreamErrorJobDetails", + "description": "If the job_details flag was set in the request, details about the current streaming job will be returned in the response body.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the current streaming job." + } + ] + } + }, + "type_stream:StreamError": { + "name": "StreamError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message text." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the error." + }, + { + "key": "payload_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If a payload ID was passed in the request, the same payload ID will be sent back in the response body." + }, + { + "key": "job_details", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamErrorJobDetails" + } + }, + "description": "If the job_details flag was set in the request, details about the current streaming job will be returned in the response body." + } + ] + } + }, + "type_stream:StreamJobDetailsJobDetails": { + "name": "StreamJobDetailsJobDetails", + "description": "If the job_details flag was set in the request, details about the current streaming job will be returned in the response body.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the current streaming job." + } + ] + } + }, + "type_stream:StreamJobDetails": { + "name": "StreamJobDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "warning", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Warning message text." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the error." + }, + { + "key": "payload_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If a payload ID was passed in the request, the same payload ID will be sent back in the response body." + }, + { + "key": "job_details", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamJobDetailsJobDetails" + } + }, + "description": "If the job_details flag was set in the request, details about the current streaming job will be returned in the response body." + } + ] + } + }, + "type_stream:SubscribeEvent": { + "name": "SubscribeEvent", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Stream Burst", + "shape": { + "type": "id", + "id": "type_stream:StreamBurst" + } + }, + { + "displayName": "Stream Error", + "shape": { + "type": "id", + "id": "type_stream:StreamError" + } + }, + { + "displayName": "Stream Job Details", + "shape": { + "type": "id", + "id": "type_stream:StreamJobDetails" + } + } + ] + } + }, + "type_stream:StreamDataModelsFace": { + "name": "StreamDataModelsFace", + "description": "Configuration for the facial expression emotion model.\n\nNote: Using the `reset_stream` parameter does not have any effect on face identification. A single face identifier cache is maintained over a full session whether `reset_stream` is used or not.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "facs", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Configuration for FACS predictions. If missing or null, no FACS predictions will be generated." + }, + { + "key": "descriptions", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Configuration for Descriptions predictions. If missing or null, no Descriptions predictions will be generated." + }, + { + "key": "identify_faces", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for faces across frames. If true, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If false, all faces will be tagged with an \"unknown\" ID." + }, + { + "key": "fps_pred", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 3 + } + } + }, + "description": "Number of frames per second to process. Other frames will be omitted from the response." + }, + { + "key": "prob_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 3 + } + } + }, + "description": "Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response." + }, + { + "key": "min_face_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 3 + } + } + }, + "description": "Minimum bounding box side length in pixels to treat as a face. Faces detected with a bounding box side length in pixels less than this threshold will be omitted from the response." + } + ] + } + }, + "type_stream:StreamDataModelsLanguage": { + "name": "StreamDataModelsLanguage", + "description": "Configuration for the language emotion model.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "sentiment", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Configuration for sentiment predictions. If missing or null, no sentiment predictions will be generated." + }, + { + "key": "toxicity", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Configuration for toxicity predictions. If missing or null, no toxicity predictions will be generated." + }, + { + "key": "granularity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The granularity at which to generate predictions. Values are `word`, `sentence`, `utterance`, or `passage`. To get a single prediction for the entire text of your streaming payload use `passage`. Default value is `word`." + } + ] + } + }, + "type_stream:StreamDataModels": { + "name": "StreamDataModels", + "description": "Configuration used to specify which models should be used and with what settings.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "burst", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Configuration for the vocal burst emotion model.\n\nNote: Model configuration is not currently available in streaming.\n\nPlease use the default configuration by passing an empty object `{}`." + }, + { + "key": "face", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamDataModelsFace" + } + }, + "description": "Configuration for the facial expression emotion model.\n\nNote: Using the `reset_stream` parameter does not have any effect on face identification. A single face identifier cache is maintained over a full session whether `reset_stream` is used or not." + }, + { + "key": "facemesh", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Configuration for the facemesh emotion model.\n\nNote: Model configuration is not currently available in streaming.\n\nPlease use the default configuration by passing an empty object `{}`." + }, + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamDataModelsLanguage" + } + }, + "description": "Configuration for the language emotion model." + }, + { + "key": "prosody", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Configuration for the speech prosody emotion model.\n\nNote: Model configuration is not currently available in streaming.\n\nPlease use the default configuration by passing an empty object `{}`." + } + ] + } + }, + "type_stream:StreamData": { + "name": "StreamData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "models", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_stream:StreamDataModels" + } + }, + "description": "Configuration used to specify which models should be used and with what settings." + }, + { + "key": "stream_window_ms", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 500, + "maximum": 10000, + "default": 5000 + } + } + }, + "description": "Length in milliseconds of streaming sliding window.\n\nExtending the length of this window will prepend media context from past payloads into the current payload.\n\nFor example, if on the first payload you send 500ms of data and on the second payload you send an additional 500ms of data, a window of at least 1000ms will allow the model to process all 1000ms of stream data.\n\nA window of 600ms would append the full 500ms of the second payload to the last 100ms of the first payload.\n\nNote: This feature is currently only supported for audio data and audio models. For other file types and models this parameter will be ignored." + }, + { + "key": "reset_stream", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to reset the streaming sliding window before processing the current payload.\n\nIf this parameter is set to `true` then past context will be deleted before processing the current payload.\n\nUse reset_stream when one audio file is done being processed and you do not want context to leak across files." + }, + { + "key": "raw_text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Set to `true` to enable the data parameter to be parsed as raw text rather than base64 encoded bytes.\nThis parameter is useful if you want to send text to be processed by the language model, but it cannot be used with other file types like audio, image, or video." + }, + { + "key": "job_details", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Set to `true` to get details about the job.\n\nThis parameter can be set in the same payload as data or it can be set without data and models configuration to get the job details between payloads.\n\nThis parameter is useful to get the unique job ID." + }, + { + "key": "payload_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Pass an arbitrary string as the payload ID and get it back at the top level of the socket response.\n\nThis can be useful if you have multiple requests running asynchronously and want to disambiguate responses as they are received." + } + ] + } + }, + "type_:Alternative": { + "name": "Alternative", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "language_only" + } + } + } + }, + "type_:Bcp47Tag": { + "name": "Bcp47Tag", + "shape": { + "type": "enum", + "values": [ + { + "value": "zh" + }, + { + "value": "da" + }, + { + "value": "nl" + }, + { + "value": "en" + }, + { + "value": "en-AU" + }, + { + "value": "en-IN" + }, + { + "value": "en-NZ" + }, + { + "value": "en-GB" + }, + { + "value": "fr" + }, + { + "value": "fr-CA" + }, + { + "value": "de" + }, + { + "value": "hi" + }, + { + "value": "hi-Latn" + }, + { + "value": "id" + }, + { + "value": "it" + }, + { + "value": "ja" + }, + { + "value": "ko" + }, + { + "value": "no" + }, + { + "value": "pl" + }, + { + "value": "pt" + }, + { + "value": "pt-BR" + }, + { + "value": "pt-PT" + }, + { + "value": "ru" + }, + { + "value": "es" + }, + { + "value": "es-419" + }, + { + "value": "sv" + }, + { + "value": "ta" + }, + { + "value": "tr" + }, + { + "value": "uk" + } + ] + } + }, + "type_:BoundingBox": { + "name": "BoundingBox", + "description": "A bounding box around a face.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "x", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "x-coordinate of bounding box top left corner." + }, + { + "key": "y", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "y-coordinate of bounding box top left corner." + }, + { + "key": "w", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "Bounding box width." + }, + { + "key": "h", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "Bounding box height." + } + ] + } + }, + "type_:BurstPrediction": { + "name": "BurstPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "time", + "valueShape": { + "type": "id", + "id": "type_:TimeInterval" + } + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + }, + { + "key": "descriptions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DescriptionsScore" + } + }, + "description": "Modality-specific descriptive features and their scores." + } + ] + } + }, + "type_:Classification": { + "name": "Classification", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:CompletedEmbeddingGeneration": { + "name": "CompletedEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + } + ] + } + }, + "type_:CompletedInference": { + "name": "CompletedInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "num_predictions", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of predictions that were generated by this job." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of errors that occurred while running this job." + } + ] + } + }, + "type_:CompletedTlInference": { + "name": "CompletedTlInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "num_predictions", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of predictions that were generated by this job." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of errors that occurred while running this job." + } + ] + } + }, + "type_:CompletedTraining": { + "name": "CompletedTraining", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "custom_model", + "valueShape": { + "type": "id", + "id": "type_:TrainingCustomModel" + } + }, + { + "key": "alternatives", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:TrainingCustomModel" + } + } + } + } + ] + } + }, + "type_:CustomModelPrediction": { + "name": "CustomModelPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "error", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "task_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:CustomModelRequest": { + "name": "CustomModelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "tags", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Tag" + } + } + } + } + ] + } + }, + "type_:Dataset": { + "name": "Dataset", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Dataset Id", + "shape": { + "type": "id", + "id": "type_:DatasetId" + } + }, + { + "displayName": "Dataset Version Id", + "shape": { + "type": "id", + "id": "type_:DatasetVersionId" + } + } + ] + } + }, + "type_:DatasetId": { + "name": "DatasetId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:DatasetVersionId": { + "name": "DatasetVersionId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:DescriptionsScore": { + "name": "DescriptionsScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the descriptive feature being expressed." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Embedding value for the descriptive feature being expressed." + } + ] + } + }, + "type_:Direction": { + "name": "Direction", + "shape": { + "type": "enum", + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + }, + "type_:EmbeddingGenerationBaseRequest": { + "name": "EmbeddingGenerationBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "registry_file_details", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RegistryFileDetail" + } + } + }, + "description": "File ID and File URL pairs for an asset registry file" + } + ] + } + }, + "type_:EmotionScore": { + "name": "EmotionScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the emotion being expressed." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Embedding value for the emotion being expressed." + } + ] + } + }, + "type_:Error": { + "name": "Error", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An error message." + }, + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A file path relative to the top level source URL or file." + } + ] + } + }, + "type_:EvaluationArgs": { + "name": "EvaluationArgs", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "validation", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ValidationArgs" + } + } + } + ] + } + }, + "type_:Face": { + "name": "Face", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fps_pred", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 3 + } + } + }, + "description": "Number of frames per second to process. Other frames will be omitted from the response. Set to `0` to process every frame." + }, + { + "key": "prob_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1, + "default": 0.99 + } + } + }, + "description": "Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response." + }, + { + "key": "identify_faces", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for faces across frames. If `true`, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If `false`, all faces will be tagged with an `unknown` ID." + }, + { + "key": "min_face_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 10, + "default": 60 + } + } + }, + "description": "Minimum bounding box side length in pixels to treat as a face. Faces detected with a bounding box side length in pixels less than this threshold will be omitted from the response." + }, + { + "key": "facs", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "descriptions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "save_faces", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to extract and save the detected faces in the artifacts zip created by each job." + } + ] + } + }, + "type_:FacePrediction": { + "name": "FacePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "frame", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Frame number" + }, + { + "key": "time", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Time in seconds when face detection occurred." + }, + { + "key": "prob", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The predicted probability that a detected face was actually a face." + }, + { + "key": "box", + "valueShape": { + "type": "id", + "id": "type_:BoundingBox" + } + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + }, + { + "key": "facs", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FacsScore" + } + } + }, + "description": "FACS 2.0 features and their scores." + }, + { + "key": "descriptions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DescriptionsScore" + } + } + }, + "description": "Modality-specific descriptive features and their scores." + } + ] + } + }, + "type_:FacemeshPrediction": { + "name": "FacemeshPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + } + ] + } + }, + "type_:FacsScore": { + "name": "FacsScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the FACS 2.0 feature being expressed." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Embedding value for the FACS 2.0 feature being expressed." + } + ] + } + }, + "type_:Failed": { + "name": "Failed", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An error message." + } + ] + } + }, + "type_:File": { + "name": "File", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "filename", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the file." + }, + { + "key": "content_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content type of the file." + }, + { + "key": "md5sum", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The MD5 checksum of the file." + } + ] + } + }, + "type_:Granularity": { + "name": "Granularity", + "description": "The granularity at which to generate predictions. `utterance` corresponds to a natural pause or break in conversation, while `conversational_turn` corresponds to a change in speaker.", + "shape": { + "type": "enum", + "values": [ + { + "value": "word" + }, + { + "value": "sentence" + }, + { + "value": "utterance" + }, + { + "value": "conversational_turn" + } + ] + } + }, + "type_:GroupedPredictionsBurstPrediction": { + "name": "GroupedPredictionsBurstPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BurstPrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsFacePrediction": { + "name": "GroupedPredictionsFacePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FacePrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsFacemeshPrediction": { + "name": "GroupedPredictionsFacemeshPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FacemeshPrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsLanguagePrediction": { + "name": "GroupedPredictionsLanguagePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LanguagePrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsNerPrediction": { + "name": "GroupedPredictionsNerPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:NerPrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsProsodyPrediction": { + "name": "GroupedPredictionsProsodyPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProsodyPrediction" + } + } + } + ] + } + }, + "type_:InProgress": { + "name": "InProgress", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + } + ] + } + }, + "type_:InferenceBaseRequest": { + "name": "InferenceBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "models", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Models" + } + } + }, + { + "key": "transcription", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Transcription" + } + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.\n\nIf you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`)." + }, + { + "key": "registry_files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "List of File IDs corresponding to the files in the asset registry." + }, + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Text to supply directly to our language and NER models." + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure." + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to send an email notification to the user upon job completion/failure." + } + ] + } + }, + "type_:InferencePrediction": { + "name": "InferencePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A file path relative to the top level source URL or file." + }, + { + "key": "models", + "valueShape": { + "type": "id", + "id": "type_:ModelsPredictions" + } + } + ] + } + }, + "type_:InferenceRequest": { + "name": "InferenceRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "models", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Models" + } + } + }, + { + "key": "transcription", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Transcription" + } + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.\n\nIf you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`)." + }, + { + "key": "registry_files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "List of File IDs corresponding to the files in the asset registry." + }, + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Text to supply directly to our language and NER models." + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure." + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to send an email notification to the user upon job completion/failure." + }, + { + "key": "files", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:File" + } + } + } + ] + } + }, + "type_:InferenceResults": { + "name": "InferenceResults", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:InferencePrediction" + } + } + }, + { + "key": "errors", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Error" + } + } + } + ] + } + }, + "type_:InferenceSourcePredictResult": { + "name": "InferenceSourcePredictResult", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "results", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:InferenceResults" + } + } + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An error message." + } + ] + } + }, + "type_:JobEmbeddingGeneration": { + "name": "JobEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:EmbeddingGenerationBaseRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateEmbeddingGeneration" + } + } + ] + } + }, + "type_:JobInference": { + "name": "JobInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:InferenceRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateInference" + } + } + ] + } + }, + "type_:JobTlInference": { + "name": "JobTlInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:TlInferenceBaseRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateTlInference" + } + } + ] + } + }, + "type_:JobTraining": { + "name": "JobTraining", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:TrainingBaseRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateTraining" + } + } + ] + } + }, + "type_:JobId": { + "name": "JobId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the started job." + } + ] + } + }, + "type_:Language": { + "name": "Language", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "granularity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Granularity" + } + } + }, + { + "key": "sentiment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "toxicity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + } + ] + } + }, + "type_:LanguagePrediction": { + "name": "LanguagePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A segment of text (like a word or a sentence)." + }, + { + "key": "position", + "valueShape": { + "type": "id", + "id": "type_:PositionInterval" + } + }, + { + "key": "time", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TimeInterval" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence in this text." + }, + { + "key": "speaker_confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence that this text was spoken by this speaker." + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + }, + { + "key": "sentiment", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SentimentScore" + } + } + }, + "description": "Sentiment predictions returned as a distribution. This model predicts the probability that a given text could be interpreted as having each sentiment level from `1` (negative) to `9` (positive).\n\nCompared to returning one estimate of sentiment, this enables a more nuanced analysis of a text's meaning. For example, a text with very neutral sentiment would have an average rating of `5`. But also a text that could be interpreted as having very positive sentiment or very negative sentiment would also have an average rating of `5`. The average sentiment is less informative than the distribution over sentiment, so this API returns a value for each sentiment level." + }, + { + "key": "toxicity", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToxicityScore" + } + } + }, + "description": "Toxicity predictions returned as probabilities that the text can be classified into the following categories: `toxic`, `severe_toxic`, `obscene`, `threat`, `insult`, and `identity_hate`." + } + ] + } + }, + "type_:Models": { + "name": "Models", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "face", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Face" + } + } + }, + { + "key": "burst", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "prosody", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Prosody" + } + } + }, + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Language" + } + } + }, + { + "key": "ner", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Ner" + } + } + }, + { + "key": "facemesh", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + } + ] + } + }, + "type_:ModelsPredictions": { + "name": "ModelsPredictions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "face", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalNullFacePrediction" + } + } + }, + { + "key": "burst", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalNullBurstPrediction" + } + } + }, + { + "key": "prosody", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction" + } + } + }, + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction" + } + } + }, + { + "key": "ner", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalTranscriptionMetadataNerPrediction" + } + } + }, + { + "key": "facemesh", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalNullFacemeshPrediction" + } + } + } + ] + } + }, + "type_:Ner": { + "name": "Ner", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + } + ] + } + }, + "type_:NerPrediction": { + "name": "NerPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "entity", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The recognized topic or entity." + }, + { + "key": "position", + "valueShape": { + "type": "id", + "id": "type_:PositionInterval" + } + }, + { + "key": "entity_confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Our NER model's relative confidence in the recognized topic or entity." + }, + { + "key": "support", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "A measure of how often the entity is linked to by other entities." + }, + { + "key": "uri", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A URL which provides more information about the recognized topic or entity." + }, + { + "key": "link_word", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The specific word to which the emotion predictions are linked." + }, + { + "key": "time", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TimeInterval" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence in this text." + }, + { + "key": "speaker_confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence that this text was spoken by this speaker." + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + } + ] + } + }, + "type_:Null": { + "name": "Null", + "description": "No associated metadata for this model. Value will be `null`.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:PositionInterval": { + "name": "PositionInterval", + "description": "Position of a segment of text within a larger document, measured in characters. Uses zero-based indexing. The beginning index is inclusive and the end index is exclusive.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "begin", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index of the first character in the text segment, inclusive." + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index of the last character in the text segment, exclusive." + } + ] + } + }, + "type_:PredictionsOptionalNullBurstPrediction": { + "name": "PredictionsOptionalNullBurstPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Null" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsBurstPrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalNullFacePrediction": { + "name": "PredictionsOptionalNullFacePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Null" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsFacePrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalNullFacemeshPrediction": { + "name": "PredictionsOptionalNullFacemeshPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Null" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsFacemeshPrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction": { + "name": "PredictionsOptionalTranscriptionMetadataLanguagePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TranscriptionMetadata" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsLanguagePrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalTranscriptionMetadataNerPrediction": { + "name": "PredictionsOptionalTranscriptionMetadataNerPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TranscriptionMetadata" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsNerPrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction": { + "name": "PredictionsOptionalTranscriptionMetadataProsodyPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TranscriptionMetadata" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsProsodyPrediction" + } + } + } + ] + } + }, + "type_:Prosody": { + "name": "Prosody", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "granularity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Granularity" + } + } + }, + { + "key": "window", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Window" + } + } + }, + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + } + ] + } + }, + "type_:ProsodyPrediction": { + "name": "ProsodyPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A segment of text (like a word or a sentence)." + }, + { + "key": "time", + "valueShape": { + "type": "id", + "id": "type_:TimeInterval" + } + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence in this text." + }, + { + "key": "speaker_confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence that this text was spoken by this speaker." + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + } + ] + } + }, + "type_:Queued": { + "name": "Queued", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + } + ] + } + }, + "type_:RegistryFileDetail": { + "name": "RegistryFileDetail", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File ID in the Asset Registry" + }, + { + "key": "file_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "URL to the file in the Asset Registry" + } + ] + } + }, + "type_:Regression": { + "name": "Regression", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:SentimentScore": { + "name": "SentimentScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Level of sentiment, ranging from `1` (negative) to `9` (positive)" + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Prediction for this level of sentiment" + } + ] + } + }, + "type_:SortBy": { + "name": "SortBy", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "started" + }, + { + "value": "ended" + } + ] + } + }, + "type_:Source": { + "name": "Source", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "url", + "extends": [ + "type_:SourceUrl" + ], + "properties": [] + }, + { + "discriminantValue": "file", + "extends": [ + "type_:SourceFile" + ], + "properties": [] + }, + { + "discriminantValue": "text", + "extends": [ + "type_:SourceTextSource" + ], + "properties": [] + } + ] + } + }, + "type_:SourceFile": { + "name": "SourceFile", + "shape": { + "type": "object", + "extends": [ + "type_:File" + ], + "properties": [] + } + }, + "type_:SourceTextSource": { + "name": "SourceTextSource", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:SourceUrl": { + "name": "SourceUrl", + "shape": { + "type": "object", + "extends": [ + "type_:Url" + ], + "properties": [] + } + }, + "type_:Url": { + "name": "Url", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL of the source media file." + } + ] + } + }, + "type_:StateEmbeddingGeneration": { + "name": "StateEmbeddingGeneration", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateEmbeddingGenerationQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateEmbeddingGenerationInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateEmbeddingGenerationCompletedEmbeddingGeneration" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateEmbeddingGenerationFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateEmbeddingGenerationCompletedEmbeddingGeneration": { + "name": "StateEmbeddingGenerationCompletedEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedEmbeddingGeneration" + ], + "properties": [] + } + }, + "type_:StateEmbeddingGenerationFailed": { + "name": "StateEmbeddingGenerationFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateEmbeddingGenerationInProgress": { + "name": "StateEmbeddingGenerationInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateEmbeddingGenerationQueued": { + "name": "StateEmbeddingGenerationQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:StateInference": { + "name": "StateInference", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateInferenceQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateInferenceInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateInferenceCompletedInference" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateInferenceFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateInferenceCompletedInference": { + "name": "StateInferenceCompletedInference", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedInference" + ], + "properties": [] + } + }, + "type_:StateInferenceFailed": { + "name": "StateInferenceFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateInferenceInProgress": { + "name": "StateInferenceInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateInferenceQueued": { + "name": "StateInferenceQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:StateTlInference": { + "name": "StateTlInference", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateTlInferenceQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateTlInferenceInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateTlInferenceCompletedTlInference" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateTlInferenceFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateTlInferenceCompletedTlInference": { + "name": "StateTlInferenceCompletedTlInference", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedTlInference" + ], + "properties": [] + } + }, + "type_:StateTlInferenceFailed": { + "name": "StateTlInferenceFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateTlInferenceInProgress": { + "name": "StateTlInferenceInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateTlInferenceQueued": { + "name": "StateTlInferenceQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:StateTraining": { + "name": "StateTraining", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateTrainingQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateTrainingInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateTrainingCompletedTraining" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateTrainingFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateTrainingCompletedTraining": { + "name": "StateTrainingCompletedTraining", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedTraining" + ], + "properties": [] + } + }, + "type_:StateTrainingFailed": { + "name": "StateTrainingFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateTrainingInProgress": { + "name": "StateTrainingInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateTrainingQueued": { + "name": "StateTrainingQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:Status": { + "name": "Status", + "shape": { + "type": "enum", + "values": [ + { + "value": "QUEUED" + }, + { + "value": "IN_PROGRESS" + }, + { + "value": "COMPLETED" + }, + { + "value": "FAILED" + } + ] + } + }, + "type_:TlInferencePrediction": { + "name": "TlInferencePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A file path relative to the top level source URL or file." + }, + { + "key": "file_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "custom_models", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:CustomModelPrediction" + } + } + } + ] + } + }, + "type_:TlInferenceResults": { + "name": "TlInferenceResults", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TlInferencePrediction" + } + } + }, + { + "key": "errors", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Error" + } + } + } + ] + } + }, + "type_:TlInferenceSourcePredictResult": { + "name": "TlInferenceSourcePredictResult", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "results", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TlInferenceResults" + } + } + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An error message." + } + ] + } + }, + "type_:Tag": { + "name": "Tag", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:Target": { + "name": "Target", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:Task": { + "name": "Task", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "classification", + "extends": [ + "type_:TaskClassification" + ], + "properties": [] + }, + { + "discriminantValue": "regression", + "extends": [ + "type_:TaskRegression" + ], + "properties": [] + } + ] + } + }, + "type_:TaskClassification": { + "name": "TaskClassification", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:TaskRegression": { + "name": "TaskRegression", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:TextSource": { + "name": "TextSource", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:TimeInterval": { + "name": "TimeInterval", + "description": "A time range with a beginning and end, measured in seconds.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "begin", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Beginning of time range in seconds." + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "End of time range in seconds." + } + ] + } + }, + "type_:TlInferenceBaseRequest": { + "name": "TlInferenceBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_model", + "valueShape": { + "type": "id", + "id": "type_:CustomModel" + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.\n\nIf you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`)." + }, + { + "key": "registry_files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "List of File IDs corresponding to the files in the asset registry." + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure." + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to send an email notification to the user upon job completion/failure." + } + ] + } + }, + "type_:CustomModel": { + "name": "CustomModel", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Custom Model Id", + "shape": { + "type": "id", + "id": "type_:CustomModelId" + } + }, + { + "displayName": "Custom Model Version Id", + "shape": { + "type": "id", + "id": "type_:CustomModelVersionId" + } + } + ] + } + }, + "type_:CustomModelId": { + "name": "CustomModelId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:CustomModelVersionId": { + "name": "CustomModelVersionId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ToxicityScore": { + "name": "ToxicityScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Category of toxicity." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Prediction for this category of toxicity" + } + ] + } + }, + "type_:TrainingBaseRequest": { + "name": "TrainingBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_model", + "valueShape": { + "type": "id", + "id": "type_:CustomModelRequest" + } + }, + { + "key": "dataset", + "valueShape": { + "type": "id", + "id": "type_:Dataset" + } + }, + { + "key": "target_feature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "label" + } + } + } + }, + { + "key": "task", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Task" + } + } + }, + { + "key": "evaluation", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluationArgs" + } + } + }, + { + "key": "alternatives", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Alternative" + } + } + } + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:TrainingCustomModel": { + "name": "TrainingCustomModel", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Transcription": { + "name": "Transcription", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Bcp47Tag" + } + } + }, + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + }, + { + "key": "confidence_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1, + "default": 0.5 + } + } + }, + "description": "Transcript confidence threshold. Transcripts generated with a confidence less than this threshold will be considered invalid and not used as an input for model inference." + } + ] + } + }, + "type_:TranscriptionMetadata": { + "name": "TranscriptionMetadata", + "description": "Transcription metadata for your media file.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Value between `0.0` and `1.0` indicating our transcription model's relative confidence in the transcription of your media file." + }, + { + "key": "detected_language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Bcp47Tag" + } + } + } + ] + } + }, + "type_:Type": { + "name": "Type", + "shape": { + "type": "enum", + "values": [ + { + "value": "EMBEDDING_GENERATION" + }, + { + "value": "INFERENCE" + }, + { + "value": "TL_INFERENCE" + }, + { + "value": "TRAINING" + } + ] + } + }, + "type_:Unconfigurable": { + "name": "Unconfigurable", + "description": "To include predictions for this model type, set this field to `{}`. It is currently not configurable further.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:UnionJob": { + "name": "UnionJob", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "EMBEDDING_GENERATION", + "extends": [ + "type_:UnionJobJobEmbeddingGeneration" + ], + "properties": [] + }, + { + "discriminantValue": "INFERENCE", + "extends": [ + "type_:UnionJobJobInference" + ], + "properties": [] + }, + { + "discriminantValue": "TL_INFERENCE", + "extends": [ + "type_:UnionJobJobTlInference" + ], + "properties": [] + }, + { + "discriminantValue": "TRAINING", + "extends": [ + "type_:UnionJobJobTraining" + ], + "properties": [] + } + ] + } + }, + "type_:UnionJobJobEmbeddingGeneration": { + "name": "UnionJobJobEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [ + "type_:JobEmbeddingGeneration" + ], + "properties": [] + } + }, + "type_:UnionJobJobInference": { + "name": "UnionJobJobInference", + "shape": { + "type": "object", + "extends": [ + "type_:JobInference" + ], + "properties": [] + } + }, + "type_:UnionJobJobTlInference": { + "name": "UnionJobJobTlInference", + "shape": { + "type": "object", + "extends": [ + "type_:JobTlInference" + ], + "properties": [] + } + }, + "type_:UnionJobJobTraining": { + "name": "UnionJobJobTraining", + "shape": { + "type": "object", + "extends": [ + "type_:JobTraining" + ], + "properties": [] + } + }, + "type_:UnionPredictResult": { + "name": "UnionPredictResult", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Inference Source Predict Result", + "shape": { + "type": "id", + "id": "type_:InferenceSourcePredictResult" + } + }, + { + "displayName": "Tl Inference Source Predict Result", + "shape": { + "type": "id", + "id": "type_:TlInferenceSourcePredictResult" + } + } + ] + } + }, + "type_:ValidationArgs": { + "name": "ValidationArgs", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "positive_label", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Target" + } + } + } + ] + } + }, + "type_:When": { + "name": "When", + "shape": { + "type": "enum", + "values": [ + { + "value": "created_before" + }, + { + "value": "created_after" + } + ] + } + }, + "type_:Window": { + "name": "Window", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "length", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0.5, + "default": 4 + } + } + }, + "description": "The length of the sliding window." + }, + { + "key": "step", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0.5, + "default": 1 + } + } + }, + "description": "The step size of the sliding window." + } + ] + } + }, + "type_:EmotionEmbeddingItem": { + "name": "EmotionEmbeddingItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the emotion being expressed." + }, + { + "key": "score", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Embedding value for the emotion being expressed." + } + ] + } + }, + "type_:EmotionEmbedding": { + "name": "EmotionEmbedding", + "description": "A high-dimensional embedding in emotion space.", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionEmbeddingItem" + } + } + } + }, + "type_:TimeRange": { + "name": "TimeRange", + "description": "A time range with a beginning and end, measured in seconds.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "begin", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "Beginning of time range in seconds." + }, + { + "key": "end", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "End of time range in seconds." + } + ] + } + }, + "type_:TextPosition": { + "name": "TextPosition", + "description": "Position of a segment of text within a larger document, measured in characters. Uses zero-based indexing. The beginning index is inclusive and the end index is exclusive.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "begin", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "The index of the first character in the text segment, inclusive." + }, + { + "key": "end", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0 + } + } + }, + "description": "The index of the last character in the text segment, exclusive." + } + ] + } + }, + "type_:SentimentItem": { + "name": "SentimentItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Level of sentiment, ranging from 1 (negative) to 9 (positive)" + }, + { + "key": "score", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Prediction for this level of sentiment" + } + ] + } + }, + "type_:Sentiment": { + "name": "Sentiment", + "description": "Sentiment predictions returned as a distribution. This model predicts the probability that a given text could be interpreted as having each sentiment level from 1 (negative) to 9 (positive).\n\nCompared to returning one estimate of sentiment, this enables a more nuanced analysis of a text's meaning. For example, a text with very neutral sentiment would have an average rating of 5. But also a text that could be interpreted as having very positive sentiment or very negative sentiment would also have an average rating of 5. The average sentiment is less informative than the distribution over sentiment, so this API returns a value for each sentiment level.", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SentimentItem" + } + } + } + }, + "type_:ToxicityItem": { + "name": "ToxicityItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Category of toxicity." + }, + { + "key": "score", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Prediction for this category of toxicity" + } + ] + } + }, + "type_:Toxicity": { + "name": "Toxicity", + "description": "Toxicity predictions returned as probabilities that the text can be classified into the following categories: toxic, severe_toxic, obscene, threat, insult, and identity_hate.", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToxicityItem" + } + } + } + } + }, + "subpackages": { + "subpackage_batch": { + "id": "subpackage_batch", + "name": "batch" + }, + "subpackage_stream": { + "id": "subpackage_stream", + "name": "stream" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-Hume-Api-Key", + "nameOverride": "apiKey" + } + } + }, + { + "id": "bcb7826e-ffd6-4440-b3de-6bf37440c3e2", + "endpoints": { + "endpoint_files.list-files": { + "id": "endpoint_files.list-files", + "namespace": [ + "subpackage_files" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/files" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Index of the first result" + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of results" + }, + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FilePage" + } + } + }, + "examples": [ + { + "path": "/v0/registry/files", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "content": [ + { + "file": { + "id": "id", + "user_id": "user_id", + "data_type": "data_type", + "is_sanitized": true, + "is_owned_by_reader": true + }, + "attributes": [ + { + "name": "name", + "value": "value" + } + ] + } + ], + "pageable": { + "offset": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "paged": true, + "unpaged": true, + "page_number": 1, + "page_size": 1 + }, + "total": 1, + "last": true, + "total_elements": 1, + "total_pages": 1, + "size": 1, + "number": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "first": true, + "number_of_elements": 1, + "empty": true + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/files \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.files.listFiles();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_files.create-files": { + "id": "endpoint_files.create-files", + "namespace": [ + "subpackage_files" + ], + "description": "Returns 201 if successful", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/registry/files" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileWithAttributesInput" + } + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileWithAttributes" + } + } + } + }, + "examples": [ + { + "path": "/v0/registry/files", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": [ + { + "file": { + "name": "name", + "hume_storage": true, + "data_type": "data_type" + } + } + ] + }, + "responseBody": { + "type": "json", + "value": [ + { + "file": { + "id": "id", + "user_id": "user_id", + "data_type": "data_type", + "is_sanitized": true, + "is_owned_by_reader": true, + "name": "name", + "uri": "uri", + "upload_uri": "upload_uri", + "thumbnail_uri": "thumbnail_uri", + "created_on": 1, + "modified_on": 1, + "metadata": { + "metadata": {} + }, + "hume_storage": true, + "hume_storage_upload_timestamp": 1, + "is_linked_to_publicly_shared": true, + "is_linked_to_hume_model": true + }, + "attributes": [ + { + "name": "name", + "value": "value" + } + ] + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/registry/files \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n {\n \"file\": {\n \"name\": \"name\",\n \"hume_storage\": true,\n \"data_type\": \"data_type\"\n }\n }\n]'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.files.createFiles([{\n file: {\n name: \"name\",\n humeStorage: true,\n dataType: \"data_type\"\n }\n }]);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_files.upload-file": { + "id": "endpoint_files.upload-file", + "namespace": [ + "subpackage_files" + ], + "description": "Upload a file synchronously. Returns 201 if successful. Files must have a name. Files must specify Content-Type. Request bodies, and therefore files, are limited to 100MB", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/registry/files/upload" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "formData", + "fields": [ + { + "type": "file", + "key": "file", + "isOptional": false + }, + { + "type": "file", + "key": "attributes", + "isOptional": true + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FileWithAttributes" + } + } + }, + "examples": [ + { + "path": "/v0/registry/files/upload", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "form", + "value": { + "file": { + "type": "filename", + "value": "" + }, + "attributes": { + "type": "filename", + "value": "" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "file": { + "id": "id", + "user_id": "user_id", + "data_type": "data_type", + "is_sanitized": true, + "is_owned_by_reader": true, + "name": "name", + "uri": "uri", + "upload_uri": "upload_uri", + "thumbnail_uri": "thumbnail_uri", + "created_on": 1, + "modified_on": 1, + "metadata": { + "metadata": {} + }, + "hume_storage": true, + "hume_storage_upload_timestamp": 1, + "is_linked_to_publicly_shared": true, + "is_linked_to_hume_model": true + }, + "attributes": [ + { + "name": "name", + "value": "value" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/registry/files/upload \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F file=@ \\\n -F attributes=@", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\nimport * as fs from \"fs\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.files.uploadFile(fs.createReadStream(\"/path/to/your/file\"), fs.createReadStream(\"/path/to/your/file\"));\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_files.get-file": { + "id": "endpoint_files.get-file", + "namespace": [ + "subpackage_files" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/files/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a File" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FileWithAttributes" + } + } + }, + "examples": [ + { + "path": "/v0/registry/files/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "file": { + "id": "id", + "user_id": "user_id", + "data_type": "data_type", + "is_sanitized": true, + "is_owned_by_reader": true, + "name": "name", + "uri": "uri", + "upload_uri": "upload_uri", + "thumbnail_uri": "thumbnail_uri", + "created_on": 1, + "modified_on": 1, + "metadata": { + "metadata": {} + }, + "hume_storage": true, + "hume_storage_upload_timestamp": 1, + "is_linked_to_publicly_shared": true, + "is_linked_to_hume_model": true + }, + "attributes": [ + { + "name": "name", + "value": "value" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/files/id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.files.getFile(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_files.delete-file": { + "id": "endpoint_files.delete-file", + "namespace": [ + "subpackage_files" + ], + "description": "Returns 204 if successful", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/registry/files/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a File" + } + ], + "examples": [ + { + "path": "/v0/registry/files/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/registry/files/id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.files.deleteFile(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_files.update-file-name": { + "id": "endpoint_files.update-file-name", + "namespace": [ + "subpackage_files" + ], + "description": "Returns 200 if successful", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/registry/files/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a File" + } + ], + "queryParameters": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "New File name" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FileWithAttributes" + } + } + }, + "examples": [ + { + "path": "/v0/registry/files/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": { + "name": "name" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "file": { + "id": "id", + "user_id": "user_id", + "data_type": "data_type", + "is_sanitized": true, + "is_owned_by_reader": true, + "name": "name", + "uri": "uri", + "upload_uri": "upload_uri", + "thumbnail_uri": "thumbnail_uri", + "created_on": 1, + "modified_on": 1, + "metadata": { + "metadata": {} + }, + "hume_storage": true, + "hume_storage_upload_timestamp": 1, + "is_linked_to_publicly_shared": true, + "is_linked_to_hume_model": true + }, + "attributes": [ + { + "name": "name", + "value": "value" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://api.hume.ai/v0/registry/files/id?name=name\" \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.files.updateFileName(\"id\", {\n name: \"name\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_files.get-file-predictions": { + "id": "endpoint_files.get-file-predictions", + "namespace": [ + "subpackage_files" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/files/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/predictions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a File" + } + ], + "examples": [ + { + "path": "/v0/registry/files/id/predictions", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/files/id/predictions \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.files.getFilePredictions(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.list-datasets": { + "id": "endpoint_datasets.list-datasets", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Dataset name to be queried" + }, + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Index of the first result" + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of results" + }, + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetPage" + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "content": [ + { + "name": "name", + "id": "id", + "latest_version": { + "id": "id", + "user_id": "user_id", + "labels_file_uri": "labels_file_uri", + "feature_types": { + "feature_types": "CATEGORICAL" + }, + "dataset_id": "dataset_id", + "dataset_version": 1, + "created_on": 1 + }, + "modified_on": 1, + "metadata": { + "metadata": {} + } + } + ], + "pageable": { + "offset": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "paged": true, + "unpaged": true, + "page_number": 1, + "page_size": 1 + }, + "total": 1, + "last": true, + "total_elements": 1, + "total_pages": 1, + "size": 1, + "number": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "first": true, + "number_of_elements": 1, + "empty": true + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/datasets \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.listDatasets();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.create-dataset": { + "id": "endpoint_datasets.create-dataset", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 201 if successful", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "formData", + "fields": [ + { + "type": "property", + "key": "name", + "description": "Name of the Dataset to be created", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "type": "file", + "key": "feature_types", + "isOptional": true + }, + { + "type": "file", + "key": "labels_file", + "isOptional": false + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnDataset" + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "form", + "value": { + "name": { + "type": "json", + "value": "name" + }, + "feature_types": { + "type": "filename", + "value": "" + }, + "labels_file": { + "type": "filename", + "value": "" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "id": "id", + "latest_version": { + "id": "id", + "user_id": "user_id", + "labels_file_uri": "labels_file_uri", + "feature_types": { + "feature_types": "CATEGORICAL" + }, + "dataset_id": "dataset_id", + "dataset_version": 1, + "created_on": 1 + }, + "modified_on": 1, + "metadata": { + "metadata": { + "metadata": { + "key": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/registry/datasets \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F name=\"name\" \\\n -F feature_types=@ \\\n -F labels_file=@", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\nimport * as fs from \"fs\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.createDataset(fs.createReadStream(\"/path/to/your/file\"), fs.createReadStream(\"/path/to/your/file\"), {\n name: \"name\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.get-dataset": { + "id": "endpoint_datasets.get-dataset", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Dataset" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnDataset" + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "id": "id", + "latest_version": { + "id": "id", + "user_id": "user_id", + "labels_file_uri": "labels_file_uri", + "feature_types": { + "feature_types": "CATEGORICAL" + }, + "dataset_id": "dataset_id", + "dataset_version": 1, + "created_on": 1 + }, + "modified_on": 1, + "metadata": { + "metadata": { + "metadata": { + "key": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/datasets/id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.getDataset(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.create-dataset-version": { + "id": "endpoint_datasets.create-dataset-version", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 200 if successful", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Dataset" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "formData", + "fields": [ + { + "type": "file", + "key": "feature_types", + "isOptional": true + }, + { + "type": "file", + "key": "labels_file", + "isOptional": false + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnDataset" + } + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "form", + "value": { + "feature_types": { + "type": "filename", + "value": "" + }, + "labels_file": { + "type": "filename", + "value": "" + } + } + }, + "responseBody": { + "type": "json", + "value": [ + { + "name": "name", + "id": "id", + "latest_version": { + "id": "id", + "user_id": "user_id", + "labels_file_uri": "labels_file_uri", + "feature_types": { + "feature_types": "CATEGORICAL" + }, + "dataset_id": "dataset_id", + "dataset_version": 1, + "created_on": 1 + }, + "modified_on": 1, + "metadata": { + "metadata": {} + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/registry/datasets/id \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F feature_types=@ \\\n -F labels_file=@", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\nimport * as fs from \"fs\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.createDatasetVersion(fs.createReadStream(\"/path/to/your/file\"), fs.createReadStream(\"/path/to/your/file\"), \"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.delete-dataset": { + "id": "endpoint_datasets.delete-dataset", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 204 if successful", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Dataset" + } + ], + "examples": [ + { + "path": "/v0/registry/datasets/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/registry/datasets/id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.deleteDataset(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.list-dataset-versions": { + "id": "endpoint_datasets.list-dataset-versions", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/versions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Dataset" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Index of the first result" + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of results" + }, + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetVersionPage" + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets/id/versions", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "content": [ + { + "id": "id", + "user_id": "user_id", + "labels_file_uri": "labels_file_uri", + "feature_types": { + "feature_types": "CATEGORICAL" + }, + "dataset_id": "dataset_id", + "dataset_version": 1, + "created_on": 1 + } + ], + "pageable": { + "offset": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "paged": true, + "unpaged": true, + "page_number": 1, + "page_size": 1 + }, + "total": 1, + "last": true, + "total_elements": 1, + "total_pages": 1, + "size": 1, + "number": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "first": true, + "number_of_elements": 1, + "empty": true + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/datasets/id/versions \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.listDatasetVersions(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.list-dataset-files": { + "id": "endpoint_datasets.list-dataset-files", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/files" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Dataset" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Index of the first result" + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of results" + }, + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FilePage" + } + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets/id/files", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "content": [ + { + "file": { + "id": "id", + "user_id": "user_id", + "data_type": "data_type", + "is_sanitized": true, + "is_owned_by_reader": true + } + } + ], + "pageable": { + "offset": 1, + "paged": true, + "unpaged": true, + "page_number": 1, + "page_size": 1 + }, + "total": 1, + "last": true, + "total_elements": 1, + "total_pages": 1, + "size": 1, + "number": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "first": true, + "number_of_elements": 1, + "empty": true + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/datasets/id/files \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.listDatasetFiles(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.get-dataset-version": { + "id": "endpoint_datasets.get-dataset-version", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets/version/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Dataset version" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DatasetLabels" + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets/version/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "user_id": "user_id", + "labels_file_uri": "labels_file_uri", + "feature_type_json_uri": "feature_type_json_uri", + "dataset_id": "dataset_id", + "dataset_version": 1, + "created_on": 1, + "is_most_recent_version": true + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/datasets/version/id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.getDatasetVersion(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_datasets.list-dataset-version-files": { + "id": "endpoint_datasets.list-dataset-version-files", + "namespace": [ + "subpackage_datasets" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/datasets/version/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/files" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Dataset version" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Index of the first result" + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of results" + }, + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FilePage" + } + } + } + }, + "examples": [ + { + "path": "/v0/registry/datasets/version/id/files", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "content": [ + { + "file": { + "id": "id", + "user_id": "user_id", + "data_type": "data_type", + "is_sanitized": true, + "is_owned_by_reader": true + } + } + ], + "pageable": { + "offset": 1, + "paged": true, + "unpaged": true, + "page_number": 1, + "page_size": 1 + }, + "total": 1, + "last": true, + "total_elements": 1, + "total_pages": 1, + "size": 1, + "number": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "first": true, + "number_of_elements": 1, + "empty": true + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/datasets/version/id/files \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.datasets.listDatasetVersionFiles(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.list-models": { + "id": "endpoint_models.list-models", + "namespace": [ + "subpackage_models" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/models" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model name to be queried" + }, + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Index of the first result" + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of results" + }, + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelPage" + } + } + }, + "examples": [ + { + "path": "/v0/registry/models", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "content": [ + { + "id": "id", + "name": "name", + "created_on": 1, + "modified_on": 1, + "total_stars": 1, + "model_is_starred_by_user": true, + "archived": true, + "is_publicly_shared": true, + "latest_version": { + "id": "id", + "model_id": "model_id", + "user_id": "user_id", + "version": "version", + "source_uri": "source_uri", + "dataset_version_id": "dataset_version_id", + "created_on": 1 + } + } + ], + "pageable": { + "offset": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "paged": true, + "unpaged": true, + "page_number": 1, + "page_size": 1 + }, + "total": 1, + "last": true, + "total_elements": 1, + "total_pages": 1, + "size": 1, + "number": 1, + "sort": { + "empty": true, + "sorted": true, + "unsorted": true + }, + "first": true, + "number_of_elements": 1, + "empty": true + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/models \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.models.listModels();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.get-model-details": { + "id": "endpoint_models.get-model-details", + "namespace": [ + "subpackage_models" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Model" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ExternalModel" + } + } + }, + "examples": [ + { + "path": "/v0/registry/models/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "created_on": 1, + "modified_on": 1, + "total_stars": 1, + "model_is_starred_by_user": true, + "archived": true, + "is_publicly_shared": true, + "latest_version": { + "id": "id", + "model_id": "model_id", + "user_id": "user_id", + "version": "version", + "source_uri": "source_uri", + "dataset_version_id": "dataset_version_id", + "created_on": 1, + "metadata": { + "metadata": {} + }, + "description": "description", + "tags": [ + { + "key": "key", + "value": "value" + } + ], + "file_type": "video", + "target_feature": "target_feature", + "task_type": "task_type", + "training_job_id": "training_job_id" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/models/id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.models.getModelDetails(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.update-model-name": { + "id": "endpoint_models.update-model-name", + "namespace": [ + "subpackage_models" + ], + "description": "Returns 200 if successful", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/registry/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Model" + } + ], + "queryParameters": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "New Model name" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ExternalModel" + } + } + }, + "examples": [ + { + "path": "/v0/registry/models/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": { + "name": "name" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "name": "name", + "created_on": 1, + "modified_on": 1, + "total_stars": 1, + "model_is_starred_by_user": true, + "archived": true, + "is_publicly_shared": true, + "latest_version": { + "id": "id", + "model_id": "model_id", + "user_id": "user_id", + "version": "version", + "source_uri": "source_uri", + "dataset_version_id": "dataset_version_id", + "created_on": 1, + "metadata": { + "metadata": {} + }, + "description": "description", + "tags": [ + { + "key": "key", + "value": "value" + } + ], + "file_type": "video", + "target_feature": "target_feature", + "task_type": "task_type", + "training_job_id": "training_job_id" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://api.hume.ai/v0/registry/models/id?name=name\" \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.models.updateModelName(\"id\", {\n name: \"name\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.list-model-versions": { + "id": "endpoint_models.list-model-versions", + "namespace": [ + "subpackage_models" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/models/version" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Hume-generated Model Version IDs to be queried" + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model version name to be queried" + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model version number to be queried" + }, + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ExternalModelVersion" + } + } + } + }, + "examples": [ + { + "path": "/v0/registry/models/version", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": "id", + "model_id": "model_id", + "user_id": "user_id", + "version": "version", + "source_uri": "source_uri", + "dataset_version_id": "dataset_version_id", + "created_on": 1, + "metadata": { + "metadata": {} + }, + "description": "description", + "tags": [ + { + "key": "key", + "value": "value" + } + ], + "file_type": "video", + "target_feature": "target_feature", + "task_type": "task_type", + "training_job_id": "training_job_id" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/models/version \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.models.listModelVersions();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.get-model-version": { + "id": "endpoint_models.get-model-version", + "namespace": [ + "subpackage_models" + ], + "description": "Returns 200 if successful", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/registry/models/version/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Model version" + } + ], + "queryParameters": [ + { + "key": "shared_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`True` Will show all assets owned by you and shared with you. `False` Will show only your assets. Default: `False`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ExternalModelVersion" + } + } + }, + "examples": [ + { + "path": "/v0/registry/models/version/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "model_id": "model_id", + "user_id": "user_id", + "version": "version", + "source_uri": "source_uri", + "dataset_version_id": "dataset_version_id", + "created_on": 1, + "metadata": { + "metadata": { + "metadata": { + "key": "value" + } + } + }, + "description": "description", + "tags": [ + { + "key": "key", + "value": "value" + } + ], + "file_type": "video", + "target_feature": "target_feature", + "task_type": "task_type", + "training_job_id": "training_job_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/registry/models/version/id \\\n -H \"X-Hume-Api-Key: \"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.models.getModelVersion(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.update-model-description": { + "id": "endpoint_models.update-model-description", + "namespace": [ + "subpackage_models" + ], + "description": "Returns 200 if successful", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/registry/models/version/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated ID of a Model Version" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ExternalModelVersion" + } + } + }, + "examples": [ + { + "path": "/v0/registry/models/version/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": "string" + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "model_id": "model_id", + "user_id": "user_id", + "version": "version", + "source_uri": "source_uri", + "dataset_version_id": "dataset_version_id", + "created_on": 1, + "metadata": { + "metadata": { + "metadata": { + "key": "value" + } + } + }, + "description": "description", + "tags": [ + { + "key": "key", + "value": "value" + } + ], + "file_type": "video", + "target_feature": "target_feature", + "task_type": "task_type", + "training_job_id": "training_job_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.hume.ai/v0/registry/models/version/id \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: application/json\" \\\n -d \"string\"", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.models.updateModelDescription(\"id\", \"string\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_jobs.start-training-job": { + "id": "endpoint_jobs.start-training-job", + "namespace": [ + "subpackage_jobs" + ], + "description": "Start a new custom models training job.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/registry/v0/batch/jobs/tl/train" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:TrainingBaseRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:JobId" + } + } + }, + "examples": [ + { + "path": "/v0/registry/v0/batch/jobs/tl/train", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "custom_model": { + "name": "name" + }, + "dataset": { + "id": "id" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "job_id": "job_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/registry/v0/batch/jobs/tl/train \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"custom_model\": {\n \"name\": \"name\"\n },\n \"dataset\": {\n \"id\": \"id\"\n }\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.jobs.startTrainingJob({\n customModel: {\n name: \"name\"\n },\n dataset: {\n id: \"id\"\n }\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_jobs.start-custom-models-inference-job": { + "id": "endpoint_jobs.start-custom-models-inference-job", + "namespace": [ + "subpackage_jobs" + ], + "description": "Start a new custom models inference job.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/registry/v0/batch/jobs/tl/inference" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:TlInferenceBaseRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:JobId" + } + } + }, + "examples": [ + { + "path": "/v0/registry/v0/batch/jobs/tl/inference", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "custom_model": { + "id": "id" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "job_id": "job_id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/registry/v0/batch/jobs/tl/inference \\\n -H \"X-Hume-Api-Key: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"custom_model\": {\n \"id\": \"id\"\n }\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.customModels.jobs.startCustomModelsInferenceJob({\n customModel: {\n id: \"id\"\n }\n});\n", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:AttributeFilter": { + "name": "AttributeFilter", + "description": "List of Attributes", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Attribute name (key)" + }, + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Attribute description (value)" + } + ] + } + }, + "type_:FileInput": { + "name": "FileInput", + "description": "File details", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File name" + }, + { + "key": "uri", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "File URI" + }, + { + "key": "hume_storage", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Flag which denotes whether the file is stored with Hume" + }, + { + "key": "data_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh" + } + ] + } + }, + "type_:FileWithAttributesInput": { + "name": "FileWithAttributesInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file", + "valueShape": { + "type": "id", + "id": "type_:FileInput" + } + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:AttributeFilter" + } + } + }, + "description": "List of Attributes" + } + ] + } + }, + "type_:AuthorizedFile": { + "name": "AuthorizedFile", + "description": "File details", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated File ID" + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "File name" + }, + { + "key": "uri", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "File URI" + }, + { + "key": "upload_uri", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "File upload URI" + }, + { + "key": "thumbnail_uri", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "File thumbnail URI" + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated User ID" + }, + { + "key": "data_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh" + }, + { + "key": "created_on", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Created date and time" + }, + { + "key": "modified_on", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Updated date and time" + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "description": "Additional details as key, value pairs" + }, + { + "key": "hume_storage", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Flag which denotes whether the file is stored with Hume" + }, + { + "key": "hume_storage_upload_timestamp", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp denoting when the file was uploaded to Hume" + }, + { + "key": "is_sanitized", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Indicates whether this file has been sanitized for sharing" + }, + { + "key": "is_owned_by_reader", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Indicates whether this file is owned by the current file reader" + }, + { + "key": "is_linked_to_publicly_shared", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether this file is linked to a model that is publicly shared" + }, + { + "key": "is_linked_to_hume_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether this file is linked to a Hume-owned model that is publicly shared" + } + ] + } + }, + "type_:FileWithAttributes": { + "name": "FileWithAttributes", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file", + "valueShape": { + "type": "id", + "id": "type_:AuthorizedFile" + } + }, + { + "key": "attributes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:AttributeFilter" + } + } + }, + "description": "List of Attributes" + } + ] + } + }, + "type_:Unit": { + "name": "Unit", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:DatasetVersionFeatureTypesValue": { + "name": "DatasetVersionFeatureTypesValue", + "description": "Feature types of label mapped to feature type", + "shape": { + "type": "enum", + "values": [ + { + "value": "CATEGORICAL" + }, + { + "value": "NUMERIC" + }, + { + "value": "TEXT" + }, + { + "value": "DATETIME" + }, + { + "value": "UNDEFINED" + } + ] + } + }, + "type_:DatasetVersion": { + "name": "DatasetVersion", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Dataset version ID" + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated User ID" + }, + { + "key": "labels_file_uri", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Dataset Labels file URI" + }, + { + "key": "feature_types", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:DatasetVersionFeatureTypesValue" + } + }, + "description": "Feature types of label mapped to feature type" + }, + { + "key": "dataset_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Dataset ID of the parent Dataset" + }, + { + "key": "dataset_version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Dataset version number" + }, + { + "key": "created_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Created date and time" + } + ] + } + }, + "type_:ReturnDataset": { + "name": "ReturnDataset", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Hume-generated Dataset ID" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Dataset name" + }, + { + "key": "latest_version", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DatasetVersion" + } + } + }, + { + "key": "modified_on", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Updated date and time" + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "description": "Additional details as key, value pairs" + } + ] + } + }, + "type_:DatasetLabelsFileUriInputFeatureTypesValue": { + "name": "DatasetLabelsFileUriInputFeatureTypesValue", + "description": "Feature types as key, value pairs", + "shape": { + "type": "enum", + "values": [ + { + "value": "CATEGORICAL" + }, + { + "value": "NUMERIC" + }, + { + "value": "TEXT" + }, + { + "value": "DATETIME" + }, + { + "value": "UNDEFINED" + } + ] + } + }, + "type_:DatasetLabelsFileUriInput": { + "name": "DatasetLabelsFileUriInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Dataset name" + }, + { + "key": "labels_file_uri", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "URI of a Labels File" + }, + { + "key": "feature_types", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:DatasetLabelsFileUriInputFeatureTypesValue" + } + }, + "description": "Feature types as key, value pairs" + } + ] + } + }, + "type_:ExternalModel": { + "name": "ExternalModel", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Model ID" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Model name" + }, + { + "key": "created_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Created date and time" + }, + { + "key": "modified_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Updated date and time" + }, + { + "key": "total_stars", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Total stars on this model" + }, + { + "key": "model_is_starred_by_user", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Model is starred by this user" + }, + { + "key": "archived", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Model is archived." + }, + { + "key": "latest_version", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExternalModelVersion" + } + } + }, + { + "key": "is_publicly_shared", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Model is shared publicly" + } + ] + } + }, + "type_:ExternalModelVersionFileType": { + "name": "ExternalModelVersionFileType", + "description": "File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh", + "shape": { + "type": "enum", + "values": [ + { + "value": "video" + }, + { + "value": "audio" + }, + { + "value": "video_no_audio" + }, + { + "value": "image" + }, + { + "value": "text" + }, + { + "value": "mediapipe_facemesh" + } + ] + } + }, + "type_:ExternalModelVersion": { + "name": "ExternalModelVersion", + "description": "Latest Model version number", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Model version ID" + }, + { + "key": "model_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Model ID of the parent Model" + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated User ID" + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Model version number" + }, + { + "key": "source_uri", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Model version's source file URI" + }, + { + "key": "dataset_version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Dataset version ID for the Dataset version the Model version was trained on" + }, + { + "key": "created_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Created date and time" + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "description": "Additional details as key, value pairs" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model version description" + }, + { + "key": "tags", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ExternalModelVersionTag" + } + } + }, + "description": "List of Tags associated with the Model version" + }, + { + "key": "file_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExternalModelVersionFileType" + } + }, + "description": "File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh" + }, + { + "key": "target_feature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Target feature, the feature the model was trained against" + }, + { + "key": "task_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Type of the task used to train" + }, + { + "key": "training_job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the batch training job" + } + ] + } + }, + "type_:ExternalModelVersionTag": { + "name": "ExternalModelVersionTag", + "description": "List of Tags associated with the Model version", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Tag name (key)" + }, + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Tag description (value)" + } + ] + } + }, + "type_:ModelPage": { + "name": "ModelPage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ExternalModel" + } + } + } + }, + { + "key": "pageable", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PageableObject" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "last", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "total_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total_pages", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "sort", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortObject" + } + } + }, + { + "key": "first", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "number_of_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "empty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:PageableObject": { + "name": "PageableObject", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "sort", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortObject" + } + } + }, + { + "key": "paged", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "unpaged", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:SortObject": { + "name": "SortObject", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "empty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "sorted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "unsorted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:JsonObject": { + "name": "JsonObject", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "empty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:FilePage": { + "name": "FilePage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FileWithAttributes" + } + } + } + }, + { + "key": "pageable", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PageableObject" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "last", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "total_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total_pages", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "sort", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortObject" + } + } + }, + { + "key": "first", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "number_of_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "empty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:DatasetPage": { + "name": "DatasetPage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnDataset" + } + } + } + }, + { + "key": "pageable", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PageableObject" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "last", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "total_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total_pages", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "sort", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortObject" + } + } + }, + { + "key": "first", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "number_of_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "empty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:DatasetVersionPage": { + "name": "DatasetVersionPage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DatasetVersion" + } + } + } + }, + { + "key": "pageable", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PageableObject" + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "last", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "total_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total_pages", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "sort", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SortObject" + } + } + }, + { + "key": "first", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "number_of_elements", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "empty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:DatasetLabels": { + "name": "DatasetLabels", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Dataset version ID" + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated User ID" + }, + { + "key": "labels_file_uri", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Dataset Labels file URI" + }, + { + "key": "feature_type_json_uri", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Feature types json file URI" + }, + { + "key": "dataset_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Hume-generated Dataset ID" + }, + { + "key": "dataset_version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Dataset version number" + }, + { + "key": "created_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Created date and time" + }, + { + "key": "is_most_recent_version", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Boolean indicating that this is the most recent version" + } + ] + } + }, + "type_:Alternative": { + "name": "Alternative", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "language_only" + } + } + } + }, + "type_:Bcp47Tag": { + "name": "Bcp47Tag", + "shape": { + "type": "enum", + "values": [ + { + "value": "zh" + }, + { + "value": "da" + }, + { + "value": "nl" + }, + { + "value": "en" + }, + { + "value": "en-AU" + }, + { + "value": "en-IN" + }, + { + "value": "en-NZ" + }, + { + "value": "en-GB" + }, + { + "value": "fr" + }, + { + "value": "fr-CA" + }, + { + "value": "de" + }, + { + "value": "hi" + }, + { + "value": "hi-Latn" + }, + { + "value": "id" + }, + { + "value": "it" + }, + { + "value": "ja" + }, + { + "value": "ko" + }, + { + "value": "no" + }, + { + "value": "pl" + }, + { + "value": "pt" + }, + { + "value": "pt-BR" + }, + { + "value": "pt-PT" + }, + { + "value": "ru" + }, + { + "value": "es" + }, + { + "value": "es-419" + }, + { + "value": "sv" + }, + { + "value": "ta" + }, + { + "value": "tr" + }, + { + "value": "uk" + } + ] + } + }, + "type_:BoundingBox": { + "name": "BoundingBox", + "description": "A bounding box around a face.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "x", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "x-coordinate of bounding box top left corner." + }, + { + "key": "y", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "y-coordinate of bounding box top left corner." + }, + { + "key": "w", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Bounding box width." + }, + { + "key": "h", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Bounding box height." + } + ] + } + }, + "type_:BurstPrediction": { + "name": "BurstPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "time", + "valueShape": { + "type": "id", + "id": "type_:TimeInterval" + } + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + }, + { + "key": "descriptions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DescriptionsScore" + } + }, + "description": "Modality-specific descriptive features and their scores." + } + ] + } + }, + "type_:Classification": { + "name": "Classification", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:CompletedEmbeddingGeneration": { + "name": "CompletedEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + } + ] + } + }, + "type_:CompletedInference": { + "name": "CompletedInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "num_predictions", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of predictions that were generated by this job." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of errors that occurred while running this job." + } + ] + } + }, + "type_:CompletedTlInference": { + "name": "CompletedTlInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "num_predictions", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of predictions that were generated by this job." + }, + { + "key": "num_errors", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of errors that occurred while running this job." + } + ] + } + }, + "type_:CompletedTraining": { + "name": "CompletedTraining", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "custom_model", + "valueShape": { + "type": "id", + "id": "type_:TrainingCustomModel" + } + }, + { + "key": "alternatives", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:TrainingCustomModel" + } + } + } + } + ] + } + }, + "type_:CustomModelPrediction": { + "name": "CustomModelPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "output", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "error", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "task_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:CustomModelRequest": { + "name": "CustomModelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "tags", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Tag" + } + } + } + } + ] + } + }, + "type_:Dataset": { + "name": "Dataset", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Dataset Id", + "shape": { + "type": "id", + "id": "type_:DatasetId" + } + }, + { + "displayName": "Dataset Version Id", + "shape": { + "type": "id", + "id": "type_:DatasetVersionId" + } + } + ] + } + }, + "type_:DatasetId": { + "name": "DatasetId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:DatasetVersionId": { + "name": "DatasetVersionId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:DescriptionsScore": { + "name": "DescriptionsScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the descriptive feature being expressed." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Embedding value for the descriptive feature being expressed." + } + ] + } + }, + "type_:Direction": { + "name": "Direction", + "shape": { + "type": "enum", + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + }, + "type_:EmbeddingGenerationBaseRequest": { + "name": "EmbeddingGenerationBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "registry_file_details", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RegistryFileDetail" + } + } + }, + "description": "File ID and File URL pairs for an asset registry file" + } + ] + } + }, + "type_:EmotionScore": { + "name": "EmotionScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the emotion being expressed." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Embedding value for the emotion being expressed." + } + ] + } + }, + "type_:Error": { + "name": "Error", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An error message." + }, + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A file path relative to the top level source URL or file." + } + ] + } + }, + "type_:EvaluationArgs": { + "name": "EvaluationArgs", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "validation", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ValidationArgs" + } + } + } + ] + } + }, + "type_:Face": { + "name": "Face", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fps_pred", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 3 + } + } + }, + "description": "Number of frames per second to process. Other frames will be omitted from the response. Set to `0` to process every frame." + }, + { + "key": "prob_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1, + "default": 0.99 + } + } + }, + "description": "Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response." + }, + { + "key": "identify_faces", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for faces across frames. If `true`, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If `false`, all faces will be tagged with an `unknown` ID." + }, + { + "key": "min_face_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 10, + "default": 60 + } + } + }, + "description": "Minimum bounding box side length in pixels to treat as a face. Faces detected with a bounding box side length in pixels less than this threshold will be omitted from the response." + }, + { + "key": "facs", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "descriptions", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "save_faces", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to extract and save the detected faces in the artifacts zip created by each job." + } + ] + } + }, + "type_:FacePrediction": { + "name": "FacePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "frame", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Frame number" + }, + { + "key": "time", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Time in seconds when face detection occurred." + }, + { + "key": "prob", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "The predicted probability that a detected face was actually a face." + }, + { + "key": "box", + "valueShape": { + "type": "id", + "id": "type_:BoundingBox" + } + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + }, + { + "key": "facs", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FacsScore" + } + } + }, + "description": "FACS 2.0 features and their scores." + }, + { + "key": "descriptions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:DescriptionsScore" + } + } + }, + "description": "Modality-specific descriptive features and their scores." + } + ] + } + }, + "type_:FacemeshPrediction": { + "name": "FacemeshPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + } + ] + } + }, + "type_:FacsScore": { + "name": "FacsScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the FACS 2.0 feature being expressed." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Embedding value for the FACS 2.0 feature being expressed." + } + ] + } + }, + "type_:Failed": { + "name": "Failed", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + }, + { + "key": "ended_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job ended (Unix timestamp in milliseconds)." + }, + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An error message." + } + ] + } + }, + "type_:File": { + "name": "File", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "filename", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the file." + }, + { + "key": "content_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content type of the file." + }, + { + "key": "md5sum", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The MD5 checksum of the file." + } + ] + } + }, + "type_:Granularity": { + "name": "Granularity", + "description": "The granularity at which to generate predictions. `utterance` corresponds to a natural pause or break in conversation, while `conversational_turn` corresponds to a change in speaker.", + "shape": { + "type": "enum", + "values": [ + { + "value": "word" + }, + { + "value": "sentence" + }, + { + "value": "utterance" + }, + { + "value": "conversational_turn" + } + ] + } + }, + "type_:GroupedPredictionsBurstPrediction": { + "name": "GroupedPredictionsBurstPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BurstPrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsFacePrediction": { + "name": "GroupedPredictionsFacePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FacePrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsFacemeshPrediction": { + "name": "GroupedPredictionsFacemeshPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:FacemeshPrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsLanguagePrediction": { + "name": "GroupedPredictionsLanguagePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LanguagePrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsNerPrediction": { + "name": "GroupedPredictionsNerPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:NerPrediction" + } + } + } + ] + } + }, + "type_:GroupedPredictionsProsodyPrediction": { + "name": "GroupedPredictionsProsodyPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals." + }, + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProsodyPrediction" + } + } + } + ] + } + }, + "type_:InProgress": { + "name": "InProgress", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + }, + { + "key": "started_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job started (Unix timestamp in milliseconds)." + } + ] + } + }, + "type_:InferenceBaseRequest": { + "name": "InferenceBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "models", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Models" + } + } + }, + { + "key": "transcription", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Transcription" + } + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.\n\nIf you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`)." + }, + { + "key": "registry_files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "List of File IDs corresponding to the files in the asset registry." + }, + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Text to supply directly to our language and NER models." + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure." + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to send an email notification to the user upon job completion/failure." + } + ] + } + }, + "type_:InferencePrediction": { + "name": "InferencePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A file path relative to the top level source URL or file." + }, + { + "key": "models", + "valueShape": { + "type": "id", + "id": "type_:ModelsPredictions" + } + } + ] + } + }, + "type_:InferenceRequest": { + "name": "InferenceRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "models", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Models" + } + } + }, + { + "key": "transcription", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Transcription" + } + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.\n\nIf you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`)." + }, + { + "key": "registry_files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "List of File IDs corresponding to the files in the asset registry." + }, + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Text to supply directly to our language and NER models." + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure." + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to send an email notification to the user upon job completion/failure." + }, + { + "key": "files", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:File" + } + } + } + ] + } + }, + "type_:InferenceResults": { + "name": "InferenceResults", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:InferencePrediction" + } + } + }, + { + "key": "errors", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Error" + } + } + } + ] + } + }, + "type_:InferenceSourcePredictResult": { + "name": "InferenceSourcePredictResult", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "results", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:InferenceResults" + } + } + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An error message." + } + ] + } + }, + "type_:JobEmbeddingGeneration": { + "name": "JobEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:EmbeddingGenerationBaseRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateEmbeddingGeneration" + } + } + ] + } + }, + "type_:JobInference": { + "name": "JobInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:InferenceRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateInference" + } + } + ] + } + }, + "type_:JobTlInference": { + "name": "JobTlInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:TlInferenceBaseRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateTlInference" + } + } + ] + } + }, + "type_:JobTraining": { + "name": "JobTraining", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID associated with this job." + }, + { + "key": "user_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "request", + "valueShape": { + "type": "id", + "id": "type_:TrainingBaseRequest" + } + }, + { + "key": "state", + "valueShape": { + "type": "id", + "id": "type_:StateTraining" + } + } + ] + } + }, + "type_:JobId": { + "name": "JobId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the started job." + } + ] + } + }, + "type_:Language": { + "name": "Language", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "granularity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Granularity" + } + } + }, + { + "key": "sentiment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "toxicity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + } + ] + } + }, + "type_:LanguagePrediction": { + "name": "LanguagePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A segment of text (like a word or a sentence)." + }, + { + "key": "position", + "valueShape": { + "type": "id", + "id": "type_:PositionInterval" + } + }, + { + "key": "time", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TimeInterval" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence in this text." + }, + { + "key": "speaker_confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence that this text was spoken by this speaker." + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + }, + { + "key": "sentiment", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SentimentScore" + } + } + }, + "description": "Sentiment predictions returned as a distribution. This model predicts the probability that a given text could be interpreted as having each sentiment level from `1` (negative) to `9` (positive).\n\nCompared to returning one estimate of sentiment, this enables a more nuanced analysis of a text's meaning. For example, a text with very neutral sentiment would have an average rating of `5`. But also a text that could be interpreted as having very positive sentiment or very negative sentiment would also have an average rating of `5`. The average sentiment is less informative than the distribution over sentiment, so this API returns a value for each sentiment level." + }, + { + "key": "toxicity", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ToxicityScore" + } + } + }, + "description": "Toxicity predictions returned as probabilities that the text can be classified into the following categories: `toxic`, `severe_toxic`, `obscene`, `threat`, `insult`, and `identity_hate`." + } + ] + } + }, + "type_:Models": { + "name": "Models", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "face", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Face" + } + } + }, + { + "key": "burst", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + }, + { + "key": "prosody", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Prosody" + } + } + }, + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Language" + } + } + }, + { + "key": "ner", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Ner" + } + } + }, + { + "key": "facemesh", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Unconfigurable" + } + } + } + ] + } + }, + "type_:ModelsPredictions": { + "name": "ModelsPredictions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "face", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalNullFacePrediction" + } + } + }, + { + "key": "burst", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalNullBurstPrediction" + } + } + }, + { + "key": "prosody", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction" + } + } + }, + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction" + } + } + }, + { + "key": "ner", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalTranscriptionMetadataNerPrediction" + } + } + }, + { + "key": "facemesh", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PredictionsOptionalNullFacemeshPrediction" + } + } + } + ] + } + }, + "type_:Ner": { + "name": "Ner", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + } + ] + } + }, + "type_:NerPrediction": { + "name": "NerPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "entity", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The recognized topic or entity." + }, + { + "key": "position", + "valueShape": { + "type": "id", + "id": "type_:PositionInterval" + } + }, + { + "key": "entity_confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Our NER model's relative confidence in the recognized topic or entity." + }, + { + "key": "support", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "A measure of how often the entity is linked to by other entities." + }, + { + "key": "uri", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A URL which provides more information about the recognized topic or entity." + }, + { + "key": "link_word", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The specific word to which the emotion predictions are linked." + }, + { + "key": "time", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TimeInterval" + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence in this text." + }, + { + "key": "speaker_confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence that this text was spoken by this speaker." + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + } + ] + } + }, + "type_:Null": { + "name": "Null", + "description": "No associated metadata for this model. Value will be `null`.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:PositionInterval": { + "name": "PositionInterval", + "description": "Position of a segment of text within a larger document, measured in characters. Uses zero-based indexing. The beginning index is inclusive and the end index is exclusive.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "begin", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index of the first character in the text segment, inclusive." + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The index of the last character in the text segment, exclusive." + } + ] + } + }, + "type_:PredictionsOptionalNullBurstPrediction": { + "name": "PredictionsOptionalNullBurstPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Null" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsBurstPrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalNullFacePrediction": { + "name": "PredictionsOptionalNullFacePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Null" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsFacePrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalNullFacemeshPrediction": { + "name": "PredictionsOptionalNullFacemeshPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Null" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsFacemeshPrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalTranscriptionMetadataLanguagePrediction": { + "name": "PredictionsOptionalTranscriptionMetadataLanguagePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TranscriptionMetadata" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsLanguagePrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalTranscriptionMetadataNerPrediction": { + "name": "PredictionsOptionalTranscriptionMetadataNerPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TranscriptionMetadata" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsNerPrediction" + } + } + } + ] + } + }, + "type_:PredictionsOptionalTranscriptionMetadataProsodyPrediction": { + "name": "PredictionsOptionalTranscriptionMetadataProsodyPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TranscriptionMetadata" + } + } + }, + { + "key": "grouped_predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GroupedPredictionsProsodyPrediction" + } + } + } + ] + } + }, + "type_:Prosody": { + "name": "Prosody", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "granularity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Granularity" + } + } + }, + { + "key": "window", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Window" + } + } + }, + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + } + ] + } + }, + "type_:ProsodyPrediction": { + "name": "ProsodyPrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A segment of text (like a word or a sentence)." + }, + { + "key": "time", + "valueShape": { + "type": "id", + "id": "type_:TimeInterval" + } + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence in this text." + }, + { + "key": "speaker_confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Value between `0.0` and `1.0` that indicates our transcription model's relative confidence that this text was spoken by this speaker." + }, + { + "key": "emotions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EmotionScore" + } + }, + "description": "A high-dimensional embedding in emotion space." + } + ] + } + }, + "type_:Queued": { + "name": "Queued", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_timestamp_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "When this job was created (Unix timestamp in milliseconds)." + } + ] + } + }, + "type_:RegistryFileDetail": { + "name": "RegistryFileDetail", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File ID in the Asset Registry" + }, + { + "key": "file_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "URL to the file in the Asset Registry" + } + ] + } + }, + "type_:Regression": { + "name": "Regression", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:SentimentScore": { + "name": "SentimentScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Level of sentiment, ranging from `1` (negative) to `9` (positive)" + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Prediction for this level of sentiment" + } + ] + } + }, + "type_:SortBy": { + "name": "SortBy", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "started" + }, + { + "value": "ended" + } + ] + } + }, + "type_:Source": { + "name": "Source", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "url", + "extends": [ + "type_:SourceUrl" + ], + "properties": [] + }, + { + "discriminantValue": "file", + "extends": [ + "type_:SourceFile" + ], + "properties": [] + }, + { + "discriminantValue": "text", + "extends": [ + "type_:SourceTextSource" + ], + "properties": [] + } + ] + } + }, + "type_:SourceFile": { + "name": "SourceFile", + "shape": { + "type": "object", + "extends": [ + "type_:File" + ], + "properties": [] + } + }, + "type_:SourceTextSource": { + "name": "SourceTextSource", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:SourceUrl": { + "name": "SourceUrl", + "shape": { + "type": "object", + "extends": [ + "type_:Url" + ], + "properties": [] + } + }, + "type_:Url": { + "name": "Url", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The URL of the source media file." + } + ] + } + }, + "type_:StateEmbeddingGeneration": { + "name": "StateEmbeddingGeneration", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateEmbeddingGenerationQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateEmbeddingGenerationInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateEmbeddingGenerationCompletedEmbeddingGeneration" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateEmbeddingGenerationFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateEmbeddingGenerationCompletedEmbeddingGeneration": { + "name": "StateEmbeddingGenerationCompletedEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedEmbeddingGeneration" + ], + "properties": [] + } + }, + "type_:StateEmbeddingGenerationFailed": { + "name": "StateEmbeddingGenerationFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateEmbeddingGenerationInProgress": { + "name": "StateEmbeddingGenerationInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateEmbeddingGenerationQueued": { + "name": "StateEmbeddingGenerationQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:StateInference": { + "name": "StateInference", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateInferenceQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateInferenceInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateInferenceCompletedInference" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateInferenceFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateInferenceCompletedInference": { + "name": "StateInferenceCompletedInference", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedInference" + ], + "properties": [] + } + }, + "type_:StateInferenceFailed": { + "name": "StateInferenceFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateInferenceInProgress": { + "name": "StateInferenceInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateInferenceQueued": { + "name": "StateInferenceQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:StateTlInference": { + "name": "StateTlInference", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateTlInferenceQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateTlInferenceInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateTlInferenceCompletedTlInference" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateTlInferenceFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateTlInferenceCompletedTlInference": { + "name": "StateTlInferenceCompletedTlInference", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedTlInference" + ], + "properties": [] + } + }, + "type_:StateTlInferenceFailed": { + "name": "StateTlInferenceFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateTlInferenceInProgress": { + "name": "StateTlInferenceInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateTlInferenceQueued": { + "name": "StateTlInferenceQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:StateTraining": { + "name": "StateTraining", + "shape": { + "type": "discriminatedUnion", + "discriminant": "status", + "variants": [ + { + "discriminantValue": "QUEUED", + "extends": [ + "type_:StateTrainingQueued" + ], + "properties": [] + }, + { + "discriminantValue": "IN_PROGRESS", + "extends": [ + "type_:StateTrainingInProgress" + ], + "properties": [] + }, + { + "discriminantValue": "COMPLETED", + "extends": [ + "type_:StateTrainingCompletedTraining" + ], + "properties": [] + }, + { + "discriminantValue": "FAILED", + "extends": [ + "type_:StateTrainingFailed" + ], + "properties": [] + } + ] + } + }, + "type_:StateTrainingCompletedTraining": { + "name": "StateTrainingCompletedTraining", + "shape": { + "type": "object", + "extends": [ + "type_:CompletedTraining" + ], + "properties": [] + } + }, + "type_:StateTrainingFailed": { + "name": "StateTrainingFailed", + "shape": { + "type": "object", + "extends": [ + "type_:Failed" + ], + "properties": [] + } + }, + "type_:StateTrainingInProgress": { + "name": "StateTrainingInProgress", + "shape": { + "type": "object", + "extends": [ + "type_:InProgress" + ], + "properties": [] + } + }, + "type_:StateTrainingQueued": { + "name": "StateTrainingQueued", + "shape": { + "type": "object", + "extends": [ + "type_:Queued" + ], + "properties": [] + } + }, + "type_:Status": { + "name": "Status", + "shape": { + "type": "enum", + "values": [ + { + "value": "QUEUED" + }, + { + "value": "IN_PROGRESS" + }, + { + "value": "COMPLETED" + }, + { + "value": "FAILED" + } + ] + } + }, + "type_:TlInferencePrediction": { + "name": "TlInferencePrediction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A file path relative to the top level source URL or file." + }, + { + "key": "file_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "custom_models", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:CustomModelPrediction" + } + } + } + ] + } + }, + "type_:TlInferenceResults": { + "name": "TlInferenceResults", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "predictions", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TlInferencePrediction" + } + } + }, + { + "key": "errors", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Error" + } + } + } + ] + } + }, + "type_:TlInferenceSourcePredictResult": { + "name": "TlInferenceSourcePredictResult", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "results", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TlInferenceResults" + } + } + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An error message." + } + ] + } + }, + "type_:Tag": { + "name": "Tag", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:Target": { + "name": "Target", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:Task": { + "name": "Task", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "classification", + "extends": [ + "type_:TaskClassification" + ], + "properties": [] + }, + { + "discriminantValue": "regression", + "extends": [ + "type_:TaskRegression" + ], + "properties": [] + } + ] + } + }, + "type_:TaskClassification": { + "name": "TaskClassification", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:TaskRegression": { + "name": "TaskRegression", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_:TextSource": { + "name": "TextSource", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:TimeInterval": { + "name": "TimeInterval", + "description": "A time range with a beginning and end, measured in seconds.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "begin", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Beginning of time range in seconds." + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "End of time range in seconds." + } + ] + } + }, + "type_:TlInferenceBaseRequest": { + "name": "TlInferenceBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_model", + "valueShape": { + "type": "id", + "id": "type_:CustomModel" + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) of media files.\n\nIf you wish to supply more than 100 URLs, consider providing them as an archive (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`)." + }, + { + "key": "registry_files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "List of File IDs corresponding to the files in the asset registry." + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure." + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to send an email notification to the user upon job completion/failure." + } + ] + } + }, + "type_:CustomModel": { + "name": "CustomModel", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Custom Model Id", + "shape": { + "type": "id", + "id": "type_:CustomModelId" + } + }, + { + "displayName": "Custom Model Version Id", + "shape": { + "type": "id", + "id": "type_:CustomModelVersionId" + } + } + ] + } + }, + "type_:CustomModelId": { + "name": "CustomModelId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:CustomModelVersionId": { + "name": "CustomModelVersionId", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ToxicityScore": { + "name": "ToxicityScore", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Category of toxicity." + }, + { + "key": "score", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Prediction for this category of toxicity" + } + ] + } + }, + "type_:TrainingBaseRequest": { + "name": "TrainingBaseRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_model", + "valueShape": { + "type": "id", + "id": "type_:CustomModelRequest" + } + }, + { + "key": "dataset", + "valueShape": { + "type": "id", + "id": "type_:Dataset" + } + }, + { + "key": "target_feature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "label" + } + } + } + }, + { + "key": "task", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Task" + } + } + }, + { + "key": "evaluation", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EvaluationArgs" + } + } + }, + { + "key": "alternatives", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Alternative" + } + } + } + }, + { + "key": "callback_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "notify", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:TrainingCustomModel": { + "name": "TrainingCustomModel", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "version_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Transcription": { + "name": "Transcription", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Bcp47Tag" + } + } + }, + { + "key": "identify_speakers", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to return identifiers for speakers over time. If `true`, unique identifiers will be assigned to spoken words to differentiate different speakers. If `false`, all speakers will be tagged with an `unknown` ID." + }, + { + "key": "confidence_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1, + "default": 0.5 + } + } + }, + "description": "Transcript confidence threshold. Transcripts generated with a confidence less than this threshold will be considered invalid and not used as an input for model inference." + } + ] + } + }, + "type_:TranscriptionMetadata": { + "name": "TranscriptionMetadata", + "description": "Transcription metadata for your media file.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Value between `0.0` and `1.0` indicating our transcription model's relative confidence in the transcription of your media file." + }, + { + "key": "detected_language", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Bcp47Tag" + } + } + } + ] + } + }, + "type_:Type": { + "name": "Type", + "shape": { + "type": "enum", + "values": [ + { + "value": "EMBEDDING_GENERATION" + }, + { + "value": "INFERENCE" + }, + { + "value": "TL_INFERENCE" + }, + { + "value": "TRAINING" + } + ] + } + }, + "type_:Unconfigurable": { + "name": "Unconfigurable", + "description": "To include predictions for this model type, set this field to `{}`. It is currently not configurable further.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:UnionJob": { + "name": "UnionJob", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "EMBEDDING_GENERATION", + "extends": [ + "type_:UnionJobJobEmbeddingGeneration" + ], + "properties": [] + }, + { + "discriminantValue": "INFERENCE", + "extends": [ + "type_:UnionJobJobInference" + ], + "properties": [] + }, + { + "discriminantValue": "TL_INFERENCE", + "extends": [ + "type_:UnionJobJobTlInference" + ], + "properties": [] + }, + { + "discriminantValue": "TRAINING", + "extends": [ + "type_:UnionJobJobTraining" + ], + "properties": [] + } + ] + } + }, + "type_:UnionJobJobEmbeddingGeneration": { + "name": "UnionJobJobEmbeddingGeneration", + "shape": { + "type": "object", + "extends": [ + "type_:JobEmbeddingGeneration" + ], + "properties": [] + } + }, + "type_:UnionJobJobInference": { + "name": "UnionJobJobInference", + "shape": { + "type": "object", + "extends": [ + "type_:JobInference" + ], + "properties": [] + } + }, + "type_:UnionJobJobTlInference": { + "name": "UnionJobJobTlInference", + "shape": { + "type": "object", + "extends": [ + "type_:JobTlInference" + ], + "properties": [] + } + }, + "type_:UnionJobJobTraining": { + "name": "UnionJobJobTraining", + "shape": { + "type": "object", + "extends": [ + "type_:JobTraining" + ], + "properties": [] + } + }, + "type_:UnionPredictResult": { + "name": "UnionPredictResult", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Inference Source Predict Result", + "shape": { + "type": "id", + "id": "type_:InferenceSourcePredictResult" + } + }, + { + "displayName": "Tl Inference Source Predict Result", + "shape": { + "type": "id", + "id": "type_:TlInferenceSourcePredictResult" + } + } + ] + } + }, + "type_:ValidationArgs": { + "name": "ValidationArgs", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "positive_label", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Target" + } + } + } + ] + } + }, + "type_:When": { + "name": "When", + "shape": { + "type": "enum", + "values": [ + { + "value": "created_before" + }, + { + "value": "created_after" + } + ] + } + }, + "type_:Window": { + "name": "Window", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "length", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0.5, + "default": 4 + } + } + }, + "description": "The length of the sliding window." + }, + { + "key": "step", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0.5, + "default": 1 + } + } + }, + "description": "The step size of the sliding window." + } + ] + } + } + }, + "subpackages": { + "subpackage_files": { + "id": "subpackage_files", + "name": "files" + }, + "subpackage_datasets": { + "id": "subpackage_datasets", + "name": "datasets" + }, + "subpackage_models": { + "id": "subpackage_models", + "name": "models" + }, + "subpackage_jobs": { + "id": "subpackage_jobs", + "name": "jobs" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-Hume-Api-Key", + "nameOverride": "apiKey" + } + } + }, + { + "id": "8b03e44c-d4e2-4613-a138-e25b8c65c3cb", + "endpoints": { + "endpoint_tools.list-tools": { + "id": "endpoint_tools.list-tools", + "namespace": [ + "subpackage_tools" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "restrict_to_most_recent", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Only include the most recent version of each tool in the list." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedUserDefinedTools" + } + } + }, + "examples": [ + { + "path": "/v0/evi/tools", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "page_number": 0, + "page_size": 2 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 0, + "page_size": 2, + "tools_page": [ + { + "tool_type": "FUNCTION", + "id": "d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2", + "version": 0, + "version_type": "FIXED", + "name": "get_current_location", + "created_on": 1715267200693, + "modified_on": 1715267200693, + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }}, \"required\": [\"location\"] }", + "version_description": "Fetches user's current location.", + "fallback_content": "Unable to fetch location.", + "description": "Fetches user's current location." + }, + { + "tool_type": "FUNCTION", + "id": "4442f3ea-9038-40e3-a2ce-1522b7de770f", + "version": 0, + "version_type": "FIXED", + "name": "get_current_weather", + "created_on": 1715266126705, + "modified_on": 1715266126705, + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current weather and uses celsius or fahrenheit based on location of user.", + "fallback_content": "Unable to fetch location.", + "description": "Fetches current weather and uses celsius or fahrenheit based on location of user." + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.hume.ai/v0/evi/tools \\\n -d page_number=0 \\\n -d page_size=2", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.listTools({\n pageNumber: 0,\n pageSize: 2\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.create-tool": { + "id": "endpoint_tools.create-tool", + "namespace": [ + "subpackage_tools" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Tool." + }, + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Tool." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text describing what the tool does." + }, + { + "key": "parameters", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Stringified JSON defining the parameters used by this version of the Tool." + }, + { + "key": "fallback_content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text to use if the tool fails to generate content." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnUserDefinedTool" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/tools", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "get_current_weather", + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current weather and uses celsius or fahrenheit based on location of user.", + "description": "This tool is for getting the current weather.", + "fallback_content": "Unable to fetch current weather." + } + }, + "responseBody": { + "type": "json", + "value": { + "tool_type": "FUNCTION", + "id": "aa9b71c4-723c-47ff-9f83-1a1829e74376", + "version": 0, + "version_type": "FIXED", + "name": "get_current_weather", + "created_on": 1715275452390, + "modified_on": 1715275452390, + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current weather and uses celsius or fahrenheit based on location of user.", + "fallback_content": "Unable to fetch current weather.", + "description": "This tool is for getting the current weather." + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/evi/tools \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"get_current_weather\",\n \"parameters\": \"{ \\\"type\\\": \\\"object\\\", \\\"properties\\\": { \\\"location\\\": { \\\"type\\\": \\\"string\\\", \\\"description\\\": \\\"The city and state, e.g. San Francisco, CA\\\" }, \\\"format\\\": { \\\"type\\\": \\\"string\\\", \\\"enum\\\": [\\\"celsius\\\", \\\"fahrenheit\\\"], \\\"description\\\": \\\"The temperature unit to use. Infer this from the users location.\\\" } }, \\\"required\\\": [\\\"location\\\", \\\"format\\\"] }\",\n \"version_description\": \"Fetches current weather and uses celsius or fahrenheit based on location of user.\",\n \"description\": \"This tool is for getting the current weather.\",\n \"fallback_content\": \"Unable to fetch current weather.\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.createTool({\n name: \"get_current_weather\",\n parameters: \"{ \\\"type\\\": \\\"object\\\", \\\"properties\\\": { \\\"location\\\": { \\\"type\\\": \\\"string\\\", \\\"description\\\": \\\"The city and state, e.g. San Francisco, CA\\\" }, \\\"format\\\": { \\\"type\\\": \\\"string\\\", \\\"enum\\\": [\\\"celsius\\\", \\\"fahrenheit\\\"], \\\"description\\\": \\\"The temperature unit to use. Infer this from the users location.\\\" } }, \\\"required\\\": [\\\"location\\\", \\\"format\\\"] }\",\n versionDescription: \"Fetches current weather and uses celsius or fahrenheit based on location of user.\",\n description: \"This tool is for getting the current weather.\",\n fallbackContent: \"Unable to fetch current weather.\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.list-tool-versions": { + "id": "endpoint_tools.list-tool-versions", + "namespace": [ + "subpackage_tools" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "restrict_to_most_recent", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Only include the most recent version of each tool in the list." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedUserDefinedTools" + } + } + }, + "examples": [ + { + "path": "/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea", + "responseStatusCode": 200, + "pathParameters": { + "id": "00183a3f-79ba-413d-9f3b-609864268bea" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 0, + "page_size": 10, + "tools_page": [ + { + "tool_type": "FUNCTION", + "id": "00183a3f-79ba-413d-9f3b-609864268bea", + "version": 1, + "version_type": "FIXED", + "name": "get_current_weather", + "created_on": 1715277014228, + "modified_on": 1715277602313, + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.", + "fallback_content": "Unable to fetch current weather.", + "description": "This tool is for getting the current weather." + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.listToolVersions(\"00183a3f-79ba-413d-9f3b-609864268bea\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.create-tool-version": { + "id": "endpoint_tools.create-tool-version", + "namespace": [ + "subpackage_tools" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Tool." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text describing what the tool does." + }, + { + "key": "parameters", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Stringified JSON defining the parameters used by this version of the Tool." + }, + { + "key": "fallback_content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text to use if the tool fails to generate content." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnUserDefinedTool" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea", + "responseStatusCode": 200, + "pathParameters": { + "id": "00183a3f-79ba-413d-9f3b-609864268bea" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.", + "description": "This tool is for getting the current weather.", + "fallback_content": "Unable to fetch current weather." + } + }, + "responseBody": { + "type": "json", + "value": { + "tool_type": "FUNCTION", + "id": "00183a3f-79ba-413d-9f3b-609864268bea", + "version": 1, + "version_type": "FIXED", + "name": "get_current_weather", + "created_on": 1715277014228, + "modified_on": 1715277602313, + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.", + "fallback_content": "Unable to fetch current weather.", + "description": "This tool is for getting the current weather." + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"parameters\": \"{ \\\"type\\\": \\\"object\\\", \\\"properties\\\": { \\\"location\\\": { \\\"type\\\": \\\"string\\\", \\\"description\\\": \\\"The city and state, e.g. San Francisco, CA\\\" }, \\\"format\\\": { \\\"type\\\": \\\"string\\\", \\\"enum\\\": [\\\"celsius\\\", \\\"fahrenheit\\\", \\\"kelvin\\\"], \\\"description\\\": \\\"The temperature unit to use. Infer this from the users location.\\\" } }, \\\"required\\\": [\\\"location\\\", \\\"format\\\"] }\",\n \"version_description\": \"Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.\",\n \"description\": \"This tool is for getting the current weather.\",\n \"fallback_content\": \"Unable to fetch current weather.\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.createToolVersion(\"00183a3f-79ba-413d-9f3b-609864268bea\", {\n parameters: \"{ \\\"type\\\": \\\"object\\\", \\\"properties\\\": { \\\"location\\\": { \\\"type\\\": \\\"string\\\", \\\"description\\\": \\\"The city and state, e.g. San Francisco, CA\\\" }, \\\"format\\\": { \\\"type\\\": \\\"string\\\", \\\"enum\\\": [\\\"celsius\\\", \\\"fahrenheit\\\", \\\"kelvin\\\"], \\\"description\\\": \\\"The temperature unit to use. Infer this from the users location.\\\" } }, \\\"required\\\": [\\\"location\\\", \\\"format\\\"] }\",\n versionDescription: \"Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.\",\n fallbackContent: \"Unable to fetch current weather.\",\n description: \"This tool is for getting the current weather.\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.delete-tool": { + "id": "endpoint_tools.delete-tool", + "namespace": [ + "subpackage_tools" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + } + ], + "examples": [ + { + "path": "/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea", + "responseStatusCode": 204, + "pathParameters": { + "id": "00183a3f-79ba-413d-9f3b-609864268bea" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.deleteTool(\"00183a3f-79ba-413d-9f3b-609864268bea\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.update-tool-name": { + "id": "endpoint_tools.update-tool-name", + "namespace": [ + "subpackage_tools" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Tool." + } + ] + } + }, + "examples": [ + { + "path": "/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea", + "responseStatusCode": 204, + "pathParameters": { + "id": "00183a3f-79ba-413d-9f3b-609864268bea" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "get_current_temperature" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"get_current_temperature\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.updateToolName(\"00183a3f-79ba-413d-9f3b-609864268bea\", {\n name: \"get_current_temperature\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.get-tool-version": { + "id": "endpoint_tools.get-tool-version", + "namespace": [ + "subpackage_tools" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a tool. Version numbers should be integers." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnUserDefinedTool" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea/version/1", + "responseStatusCode": 200, + "pathParameters": { + "id": "00183a3f-79ba-413d-9f3b-609864268bea", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "tool_type": "FUNCTION", + "id": "00183a3f-79ba-413d-9f3b-609864268bea", + "version": 1, + "version_type": "FIXED", + "name": "string", + "created_on": 1715277014228, + "modified_on": 1715277602313, + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.", + "fallback_content": "Unable to fetch current weather.", + "description": "This tool is for getting the current weather." + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea/version/1", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.getToolVersion(\"00183a3f-79ba-413d-9f3b-609864268bea\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.delete-tool-version": { + "id": "endpoint_tools.delete-tool-version", + "namespace": [ + "subpackage_tools" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a tool. Version numbers should be integers." + } + ], + "examples": [ + { + "path": "/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea/version/1", + "responseStatusCode": 204, + "pathParameters": { + "id": "00183a3f-79ba-413d-9f3b-609864268bea", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea/version/1", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.deleteToolVersion(\"00183a3f-79ba-413d-9f3b-609864268bea\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_tools.update-tool-description": { + "id": "endpoint_tools.update-tool-description", + "namespace": [ + "subpackage_tools" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/evi/tools/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a tool. Version numbers should be integers." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Tool." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnUserDefinedTool" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea/version/1", + "responseStatusCode": 200, + "pathParameters": { + "id": "00183a3f-79ba-413d-9f3b-609864268bea", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "version_description": "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region." + } + }, + "responseBody": { + "type": "json", + "value": { + "tool_type": "FUNCTION", + "id": "00183a3f-79ba-413d-9f3b-609864268bea", + "version": 1, + "version_type": "FIXED", + "name": "string", + "created_on": 1715277014228, + "modified_on": 1715277602313, + "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", + "version_description": "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.", + "fallback_content": "Unable to fetch current weather.", + "description": "This tool is for getting the current weather." + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.hume.ai/v0/evi/tools/00183a3f-79ba-413d-9f3b-609864268bea/version/1 \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"version_description\": \"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user\\'s region.\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.tools.updateToolDescription(\"00183a3f-79ba-413d-9f3b-609864268bea\", 1, {\n versionDescription: \"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.list-prompts": { + "id": "endpoint_prompts.list-prompts", + "namespace": [ + "subpackage_prompts" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "restrict_to_most_recent", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Only include the most recent version of each prompt in the list." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedPrompts" + } + } + }, + "examples": [ + { + "path": "/v0/evi/prompts", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 1, + "page_size": 1, + "prompts_page": [ + { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/prompts", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.listPrompts();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.create-prompt": { + "id": "endpoint_prompts.create-prompt", + "namespace": [ + "subpackage_prompts" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Prompt." + }, + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Prompt." + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Text used for this version of the Prompt." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnPrompt" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/prompts", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "name", + "text": "text" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/evi/prompts \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"name\",\n \"text\": \"text\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.createPrompt({\n name: \"name\",\n text: \"text\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.list-prompt-versions": { + "id": "endpoint_prompts.list-prompt-versions", + "namespace": [ + "subpackage_prompts" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a tool. Formatted as a UUID." + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "restrict_to_most_recent", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Only include the most recent version of each prompt in the list." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedPrompts" + } + } + }, + "examples": [ + { + "path": "/v0/evi/prompts/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 1, + "page_size": 1, + "prompts_page": [ + { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/prompts/id", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.listPromptVersions(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.create-prompt-verison": { + "id": "endpoint_prompts.create-prompt-verison", + "namespace": [ + "subpackage_prompts" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a prompt. Formatted as a UUID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Prompt." + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Text used for this version of the Prompt." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnPrompt" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/prompts/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "text": "text" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/evi/prompts/id \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"text\": \"text\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.createPromptVerison(\"id\", {\n text: \"text\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.delete-prompt": { + "id": "endpoint_prompts.delete-prompt", + "namespace": [ + "subpackage_prompts" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a prompt. Formatted as a UUID." + } + ], + "examples": [ + { + "path": "/v0/evi/prompts/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/evi/prompts/id", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.deletePrompt(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.update-prompt-name": { + "id": "endpoint_prompts.update-prompt-name", + "namespace": [ + "subpackage_prompts" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a prompt. Formatted as a UUID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Prompt." + } + ] + } + }, + "examples": [ + { + "path": "/v0/evi/prompts/:id", + "responseStatusCode": 200, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.hume.ai/v0/evi/prompts/:id \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.updatePromptName(\"string\", {\n name: \"string\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.get-prompt-version": { + "id": "endpoint_prompts.get-prompt-version", + "namespace": [ + "subpackage_prompts" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a prompt. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a prompt. Version numbers should be integers." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnPrompt" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/prompts/id/version/1", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/prompts/id/version/1", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.getPromptVersion(\"id\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.delete-prompt-version": { + "id": "endpoint_prompts.delete-prompt-version", + "namespace": [ + "subpackage_prompts" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a prompt. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a prompt. Version numbers should be integers." + } + ], + "examples": [ + { + "path": "/v0/evi/prompts/id/version/1", + "responseStatusCode": 204, + "pathParameters": { + "id": "id", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/evi/prompts/id/version/1", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.deletePromptVersion(\"id\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_prompts.update-prompt-description": { + "id": "endpoint_prompts.update-prompt-description", + "namespace": [ + "subpackage_prompts" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/evi/prompts/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a prompt. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a prompt. Version numbers should be integers." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Prompt." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnPrompt" + } + } + } + }, + "examples": [ + { + "path": "/v0/evi/prompts/id/version/1", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.hume.ai/v0/evi/prompts/id/version/1 \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.prompts.updatePromptDescription(\"id\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.list-configs": { + "id": "endpoint_configs.list-configs", + "namespace": [ + "subpackage_configs" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "restrict_to_most_recent", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Only include the most recent version of each config in the list." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedConfigs" + } + } + }, + "examples": [ + { + "path": "/v0/evi/configs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 1, + "page_size": 1, + "configs_page": [ + { + "id": "id", + "version": 1, + "version_description": "version_description", + "name": "name", + "created_on": 1, + "modified_on": 1, + "prompt": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text" + }, + "voice": { + "provider": "provider", + "name": "name" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/configs", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.listConfigs();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.create-config": { + "id": "endpoint_configs.create-config", + "namespace": [ + "subpackage_configs" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Config." + }, + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Config." + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedPromptSpec" + } + } + }, + { + "key": "voice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedVoice" + } + } + }, + { + "key": "language_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedLanguageModel" + } + } + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedUserDefinedToolSpec" + } + } + } + }, + "description": "Tool specification for a Config." + }, + { + "key": "builtin_tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedBuiltinTool" + } + } + } + }, + "description": "Built-in tool specification for a Config." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnConfig" + } + } + }, + "examples": [ + { + "path": "/v0/evi/configs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "name" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_description": "version_description", + "name": "name", + "created_on": 1, + "modified_on": 1, + "prompt": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + }, + "voice": { + "provider": "provider", + "name": "name" + }, + "language_model": { + "model_provider": "model_provider", + "model_resource": "model_resource", + "temperature": 1.1 + }, + "tools": [ + { + "tool_type": "tool_type", + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "parameters": "parameters", + "version_description": "version_description", + "fallback_content": "fallback_content", + "description": "description" + } + ], + "builtin_tools": [ + { + "tool_type": "tool_type", + "name": "name", + "fallback_content": "fallback_content" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/evi/configs \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"name\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.createConfig({\n name: \"name\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.list-config-versions": { + "id": "endpoint_configs.list-config-versions", + "namespace": [ + "subpackage_configs" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a config. Formatted as a UUID." + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "restrict_to_most_recent", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Only include the most recent version of each config in the list." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedConfigs" + } + } + }, + "examples": [ + { + "path": "/v0/evi/configs/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 1, + "page_size": 1, + "configs_page": [ + { + "id": "id", + "version": 1, + "version_description": "version_description", + "name": "name", + "created_on": 1, + "modified_on": 1, + "prompt": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text" + }, + "voice": { + "provider": "provider", + "name": "name" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/configs/id", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.listConfigVersions(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.create-config-version": { + "id": "endpoint_configs.create-config-version", + "namespace": [ + "subpackage_configs" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a config. Formatted as a UUID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Config." + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedPromptSpec" + } + } + }, + { + "key": "voice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedVoice" + } + } + }, + { + "key": "language_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedLanguageModel" + } + } + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedUserDefinedToolSpec" + } + } + } + }, + "description": "Tool specification for a Config." + }, + { + "key": "builtin_tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedBuiltinTool" + } + } + } + }, + "description": "Built-in tool specification for a Config." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnConfig" + } + } + }, + "examples": [ + { + "path": "/v0/evi/configs/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_description": "version_description", + "name": "name", + "created_on": 1, + "modified_on": 1, + "prompt": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + }, + "voice": { + "provider": "provider", + "name": "name" + }, + "language_model": { + "model_provider": "model_provider", + "model_resource": "model_resource", + "temperature": 1.1 + }, + "tools": [ + { + "tool_type": "tool_type", + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "parameters": "parameters", + "version_description": "version_description", + "fallback_content": "fallback_content", + "description": "description" + } + ], + "builtin_tools": [ + { + "tool_type": "tool_type", + "name": "name", + "fallback_content": "fallback_content" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.hume.ai/v0/evi/configs/id \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.createConfigVersion(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.delete-config": { + "id": "endpoint_configs.delete-config", + "namespace": [ + "subpackage_configs" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a config. Formatted as a UUID." + } + ], + "examples": [ + { + "path": "/v0/evi/configs/id", + "responseStatusCode": 204, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/evi/configs/id", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.deleteConfig(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.update-config-name": { + "id": "endpoint_configs.update-config-name", + "namespace": [ + "subpackage_configs" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a config. Formatted as a UUID." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Config." + } + ] + } + }, + "examples": [ + { + "path": "/v0/evi/configs/:id", + "responseStatusCode": 200, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.hume.ai/v0/evi/configs/:id \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.updateConfigName(\"string\", {\n name: \"string\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.get-config-version": { + "id": "endpoint_configs.get-config-version", + "namespace": [ + "subpackage_configs" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a config. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a config. Version numbers should be integers." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnConfig" + } + } + }, + "examples": [ + { + "path": "/v0/evi/configs/id/version/1", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_description": "version_description", + "name": "name", + "created_on": 1, + "modified_on": 1, + "prompt": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + }, + "voice": { + "provider": "provider", + "name": "name" + }, + "language_model": { + "model_provider": "model_provider", + "model_resource": "model_resource", + "temperature": 1.1 + }, + "tools": [ + { + "tool_type": "tool_type", + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "parameters": "parameters", + "version_description": "version_description", + "fallback_content": "fallback_content", + "description": "description" + } + ], + "builtin_tools": [ + { + "tool_type": "tool_type", + "name": "name", + "fallback_content": "fallback_content" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/configs/id/version/1", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.getConfigVersion(\"id\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.delete-config-version": { + "id": "endpoint_configs.delete-config-version", + "namespace": [ + "subpackage_configs" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a config. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a config. Version numbers should be integers." + } + ], + "examples": [ + { + "path": "/v0/evi/configs/id/version/1", + "responseStatusCode": 204, + "pathParameters": { + "id": "id", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.hume.ai/v0/evi/configs/id/version/1", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.deleteConfigVersion(\"id\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_configs.update-config-description": { + "id": "endpoint_configs.update-config-description", + "namespace": [ + "subpackage_configs" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v0/evi/configs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/version/" + }, + { + "type": "pathParameter", + "value": "version" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a config. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a config. Version numbers should be integers." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Config." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnConfig" + } + } + }, + "examples": [ + { + "path": "/v0/evi/configs/id/version/1", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "version": 1 + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "version": 1, + "version_description": "version_description", + "name": "name", + "created_on": 1, + "modified_on": 1, + "prompt": { + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "text": "text", + "version_description": "version_description" + }, + "voice": { + "provider": "provider", + "name": "name" + }, + "language_model": { + "model_provider": "model_provider", + "model_resource": "model_resource", + "temperature": 1.1 + }, + "tools": [ + { + "tool_type": "tool_type", + "id": "id", + "version": 1, + "version_type": "version_type", + "name": "name", + "created_on": 1, + "modified_on": 1, + "parameters": "parameters", + "version_description": "version_description", + "fallback_content": "fallback_content", + "description": "description" + } + ], + "builtin_tools": [ + { + "tool_type": "tool_type", + "name": "name", + "fallback_content": "fallback_content" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.hume.ai/v0/evi/configs/id/version/1 \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.configs.updateConfigDescription(\"id\", 1);\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.list-chats": { + "id": "endpoint_chats.list-chats", + "namespace": [ + "subpackage_chats" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/chats" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedChats" + } + } + }, + "examples": [ + { + "path": "/v0/evi/chats", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 1, + "page_size": 1, + "chats_page": [ + { + "id": "id", + "chat_group_id": "chat_group_id", + "status": "status", + "start_timestamp": 1, + "tag": "tag", + "end_timestamp": 1, + "event_count": 1, + "metadata": "metadata", + "config": { + "id": "id" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/chats", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.chats.listChats();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chats.list-chat-events": { + "id": "endpoint_chats.list-chat-events", + "namespace": [ + "subpackage_chats" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/chats/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a chat. Formatted as a UUID." + } + ], + "queryParameters": [ + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnChatPagedEvents" + } + } + }, + "examples": [ + { + "path": "/v0/evi/chats/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "chat_group_id": "chat_group_id", + "status": "status", + "start_timestamp": 1, + "events_page": [ + { + "id": "id", + "chat_id": "chat_id", + "timestamp": 1, + "role": "role", + "type": "type", + "message_text": "message_text", + "emotion_features": "emotion_features", + "metadata": "metadata" + } + ], + "page_number": 1, + "page_size": 1, + "tag": "tag", + "end_timestamp": 1, + "metadata": "metadata", + "config": { + "id": "id", + "version": 1 + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/chats/id", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.chats.listChatEvents(\"id\");\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chatGroups.list-chat-groups": { + "id": "endpoint_chatGroups.list-chat-groups", + "namespace": [ + "subpackage_chatGroups" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/chat_groups" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnPagedChatGroups" + } + } + }, + "examples": [ + { + "path": "/v0/evi/chat_groups", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "page_number": 1, + "page_size": 1, + "chat_groups_page": [ + { + "id": "id", + "first_start_timestamp": 1, + "most_recent_start_timestamp": 1, + "num_chats": 1, + "most_recent_chat_id": "most_recent_chat_id", + "active": true + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/chat_groups", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.chatGroups.listChatGroups();\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_chatGroups.list-chat-group-events": { + "id": "endpoint_chatGroups.list-chat-group-events", + "namespace": [ + "subpackage_chatGroups" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v0/evi/chat_groups/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/events" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.hume.ai" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a chat. Formatted as a UUID." + } + ], + "queryParameters": [ + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of results to include per page." + }, + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the results to return." + }, + { + "key": "ascending_order", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ReturnChatGroupPagedEvents" + } + } + }, + "examples": [ + { + "path": "/v0/evi/chat_groups/id/events", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "id", + "page_number": 1, + "page_size": 1, + "pagination_direction": "pagination_direction", + "events_page": [ + { + "id": "id", + "chat_id": "chat_id", + "timestamp": 1, + "role": "role", + "type": "type", + "message_text": "message_text", + "emotion_features": "emotion_features", + "metadata": "metadata" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.hume.ai/v0/evi/chat_groups/id/events", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { HumeClient } from \"hume\";\n\nconst hume = new HumeClient({ apiKey: \"YOUR_API_KEY\" });\nawait hume.empathicVoice.chatGroups.listChatGroupEvents(\"id\");\n", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": { + "subpackage_chat.chat": { + "id": "subpackage_chat.chat", + "namespace": [ + "subpackage_chat" + ], + "path": [ + { + "type": "literal", + "value": "/v0/evi/chat" + } + ], + "messages": [ + { + "type": "subscribe", + "origin": "server", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_chat:SubscribeEvent" + } + } + }, + { + "type": "publish", + "origin": "client", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_chat:PublishEvent" + } + } + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "wss://api.hume.ai" + } + ], + "queryParameters": [ + { + "key": "access_token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Access token used for authenticating the client." + }, + { + "key": "config_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the EVI configuration to be used." + }, + { + "key": "config_version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The version number of the specified EVI configuration to be used." + }, + { + "key": "resumed_chat_group_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for a chat group. Used to resume a previous chat." + } + ], + "examples": [ + { + "path": "/v0/evi/chat", + "pathParameters": {}, + "queryParameters": {}, + "requestHeaders": {}, + "messages": [ + { + "type": "publish", + "body": { + "data": "data", + "type": "audio_input" + } + }, + { + "type": "subscribe", + "body": { + "type": "assistant_end" + } + } + ] + } + ] + } + }, + "webhooks": {}, + "types": { + "type_chat:SubscribeEvent": { + "name": "SubscribeEvent", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Assistant End", + "shape": { + "type": "id", + "id": "type_:AssistantEnd" + } + }, + { + "displayName": "Assistant Message", + "shape": { + "type": "id", + "id": "type_:AssistantMessage" + } + }, + { + "displayName": "Audio Output", + "shape": { + "type": "id", + "id": "type_:AudioOutput" + } + }, + { + "displayName": "Chat Metadata", + "shape": { + "type": "id", + "id": "type_:ChatMetadata" + } + }, + { + "displayName": "Web Socket Error", + "shape": { + "type": "id", + "id": "type_:WebSocketError" + } + }, + { + "displayName": "User Interruption", + "shape": { + "type": "id", + "id": "type_:UserInterruption" + } + }, + { + "displayName": "User Message", + "shape": { + "type": "id", + "id": "type_:UserMessage" + } + }, + { + "displayName": "Tool Call Message", + "shape": { + "type": "id", + "id": "type_:ToolCallMessage" + } + }, + { + "displayName": "Tool Response Message", + "shape": { + "type": "id", + "id": "type_:ToolResponseMessage" + } + }, + { + "displayName": "Tool Error Message", + "shape": { + "type": "id", + "id": "type_:ToolErrorMessage" + } + } + ] + } + }, + "type_chat:PublishEvent": { + "name": "PublishEvent", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Audio Input", + "shape": { + "type": "id", + "id": "type_:AudioInput" + } + }, + { + "displayName": "Session Settings", + "shape": { + "type": "id", + "id": "type_:SessionSettings" + } + }, + { + "displayName": "User Input", + "shape": { + "type": "id", + "id": "type_:UserInput" + } + }, + { + "displayName": "Assistant Input", + "shape": { + "type": "id", + "id": "type_:AssistantInput" + } + }, + { + "displayName": "Tool Response Message", + "shape": { + "type": "id", + "id": "type_:ToolResponseMessage" + } + }, + { + "displayName": "Tool Error Message", + "shape": { + "type": "id", + "id": "type_:ToolErrorMessage" + } + }, + { + "displayName": "Pause Assistant Message", + "shape": { + "type": "id", + "id": "type_:PauseAssistantMessage" + } + }, + { + "displayName": "Resume Assistant Message", + "shape": { + "type": "id", + "id": "type_:ResumeAssistantMessage" + } + } + ] + } + }, + "type_:ReturnUserDefinedTool": { + "name": "ReturnUserDefinedTool", + "description": "A specific tool version returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "tool_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Type of Tool. Values from the ToolType enum." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a Tool. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique." + }, + { + "key": "version_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Inidicates whether this tool is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum." + }, + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Tool." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Tool." + }, + { + "key": "created_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the first version of this tool was created." + }, + { + "key": "modified_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when this version of the tool was created." + }, + { + "key": "fallback_content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text to use if the tool fails to generate content." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text describing what the tool does." + }, + { + "key": "parameters", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Stringified JSON defining the parameters used by this version of the Tool." + } + ] + } + }, + "type_:ReturnPrompt": { + "name": "ReturnPrompt", + "description": "A specific prompt version returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a Prompt. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique." + }, + { + "key": "version_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Inidicates whether this prompt is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum." + }, + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Prompt." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Prompt." + }, + { + "key": "created_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the first version of this prompt was created." + }, + { + "key": "modified_on", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when this version of the prompt was created." + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Text used for this version of the Prompt." + } + ] + } + }, + "type_:PostedBuiltinTool": { + "name": "PostedBuiltinTool", + "description": "A configuration of a built-in tool to be posted to the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Tool." + }, + { + "key": "fallback_content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text to use if the tool fails to generate content." + } + ] + } + }, + "type_:PostedLanguageModelModelProvider": { + "name": "PostedLanguageModelModelProvider", + "description": "The provider of this model. Based on the enum modelProvider.", + "shape": { + "type": "enum", + "values": [ + { + "value": "OPEN_AI" + }, + { + "value": "CUSTOM_LANGUAGE_MODEL" + }, + { + "value": "ANTHROPIC" + }, + { + "value": "FIREWORKS" + }, + { + "value": "GROQ" + } + ] + } + }, + "type_:PostedLanguageModel": { + "name": "PostedLanguageModel", + "description": "A LanguageModel to be posted to the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "model_provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PostedLanguageModelModelProvider" + } + }, + "description": "The provider of this model. Based on the enum modelProvider." + }, + { + "key": "model_resource", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String that specifies the model to use with modelProvider." + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Model temperature." + } + ] + } + }, + "type_:PostedPromptSpec": { + "name": "PostedPromptSpec", + "description": "A specific prompt identifier to be posted to the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a Prompt. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique." + } + ] + } + }, + "type_:PostedUserDefinedToolSpec": { + "name": "PostedUserDefinedToolSpec", + "description": "A specific tool identifier to be posted to the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a Tool. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique." + } + ] + } + }, + "type_:PostedVoiceName": { + "name": "PostedVoiceName", + "description": "String with the name of the voice to use.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ITO" + }, + { + "value": "DACHER" + } + ] + } + }, + "type_:PostedVoice": { + "name": "PostedVoice", + "description": "A Voice specification posted to the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "HUME_AI" + } + } + }, + "description": "The provider of the voice to use." + }, + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:PostedVoiceName" + }, + "description": "String with the name of the voice to use." + } + ] + } + }, + "type_:ReturnBuiltinTool": { + "name": "ReturnBuiltinTool", + "description": "A specific builtin tool version returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "tool_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Type of Tool. Values from the ToolType enum." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name applied to all versions of a particular Tool." + }, + { + "key": "fallback_content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Text to use if the tool fails to generate content." + } + ] + } + }, + "type_:ReturnConfig": { + "name": "ReturnConfig", + "description": "A specific config version returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Identifier for a Config. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique." + }, + { + "key": "version_description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Description that is appended to a specific version of a Config." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name applied to all versions of a particular Config." + }, + { + "key": "created_on", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The timestamp when the first version of this config was created." + }, + { + "key": "modified_on", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The timestamp when this version of the config was created." + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnPrompt" + } + } + }, + { + "key": "voice", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnVoice" + } + } + }, + { + "key": "language_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnLanguageModel" + } + } + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnUserDefinedTool" + } + } + } + }, + "description": "List of user-defined tools associated with this config." + }, + { + "key": "builtin_tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnBuiltinTool" + } + } + } + }, + "description": "List of built-in tools associated with this config" + } + ] + } + }, + "type_:ReturnLanguageModel": { + "name": "ReturnLanguageModel", + "description": "A specific LanguageModel", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "model_provider", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The provider of this model. Based on the enum modelProvider." + }, + { + "key": "model_resource", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String that specifies the model to use with modelProvider." + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Model temperature." + } + ] + } + }, + "type_:ReturnVoice": { + "name": "ReturnVoice", + "description": "A specific voice specification", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "provider", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The provider of the voice to use. Based on the enum VoiceProvider." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String with the name of the voice to use." + } + ] + } + }, + "type_:ReturnPagedUserDefinedTools": { + "name": "ReturnPagedUserDefinedTools", + "description": "A paginated list of user defined tool versions returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "page_number", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results returned per page." + }, + { + "key": "tools_page", + "valueShape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnUserDefinedTool" + } + } + }, + "description": "List of tools returned for the specified page number and page size." + } + ] + } + }, + "type_:ReturnPagedPrompts": { + "name": "ReturnPagedPrompts", + "description": "A paginated list of prompt versions returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "page_number", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results returned per page." + }, + { + "key": "prompts_page", + "valueShape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnPrompt" + } + } + }, + "description": "List of prompts returned for the specified page number and page size." + } + ] + } + }, + "type_:ReturnPagedConfigs": { + "name": "ReturnPagedConfigs", + "description": "A paginated list of config versions returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "page_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results returned per page." + }, + { + "key": "configs_page", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnConfig" + } + } + }, + "description": "List of prompts returned for the specified page number and page size." + } + ] + } + }, + "type_:ReturnChat": { + "name": "ReturnChat", + "description": "A description of chat and its status", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a chat. Formatted as a UUID." + }, + { + "key": "chat_group_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID." + }, + { + "key": "tag", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional tag applied to this chat used to group chats by user, application, etc." + }, + { + "key": "status", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The status of the chat. Values from the ChatStatus enum." + }, + { + "key": "start_timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the chat started, formatted as a Unix epoch milliseconds." + }, + { + "key": "end_timestamp", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The timestamp when the chat ended, formatted as a Unix epoch milliseconds." + }, + { + "key": "event_count", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of events currently in this chat." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Stringified JSON with additional metadata about the chat." + }, + { + "key": "config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnConfigSpec" + } + } + } + ] + } + }, + "type_:ReturnConfigSpec": { + "name": "ReturnConfigSpec", + "description": "An id/version number for a specific config version", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a Config. Formatted as a UUID." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique." + } + ] + } + }, + "type_:ReturnPagedChats": { + "name": "ReturnPagedChats", + "description": "A paginated list of chats returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "page_number", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results returned per page." + }, + { + "key": "chats_page", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnChat" + } + }, + "description": "List of chats and their metadata returned for the specified page number and page size." + } + ] + } + }, + "type_:ReturnChatEvent": { + "name": "ReturnChatEvent", + "description": "A description of a single event in a chat returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a chat event. Formatted as a UUID." + }, + { + "key": "chat_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for the chat this event occurred in. Formatted as a UUID." + }, + { + "key": "timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the chat event occurred, formatted as a Unix epoch milliseconds." + }, + { + "key": "role", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role of the user who generated the chat event. Values from the Role enum." + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The type of chat event. Values from the ChatEventType enum." + }, + { + "key": "message_text", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text of the chat message, either transcribed from speaker audio or generated by the agent." + }, + { + "key": "emotion_features", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Stringified JSON with data about emotional content/prosody of the event." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Stringified JSON with additional metadata about the chat event." + } + ] + } + }, + "type_:ReturnChatPagedEvents": { + "name": "ReturnChatPagedEvents", + "description": "A description of chat status with a paginated list of chat events returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for a chat. Formatted as a UUID." + }, + { + "key": "chat_group_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID." + }, + { + "key": "tag", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional tag applied to this chat used to group chats by user, application, etc." + }, + { + "key": "status", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The status of the chat. Values from the ChatStatus enum." + }, + { + "key": "start_timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the chat started, formatted as a Unix epoch milliseconds." + }, + { + "key": "end_timestamp", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The timestamp when the chat ended, formatted as a Unix epoch milliseconds." + }, + { + "key": "events_page", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnChatEvent" + } + }, + "description": "List of chat events with the specified page number and page size." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Stringified JSON with additional metadata about the chat." + }, + { + "key": "page_number", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results returned per page." + }, + { + "key": "config", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnConfigSpec" + } + } + } + ] + } + }, + "type_:ReturnActiveChatCount": { + "name": "ReturnActiveChatCount", + "description": "A description of current chat chat sessions for a user", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp for when chat status was measured. Formatted as a Unix epoch milliseconds." + }, + { + "key": "total_user_active_chats", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of active chats for this user." + }, + { + "key": "max_allowed_active_chats", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The maximum number of concurrent active chats for this user." + }, + { + "key": "more_active_chats_allowed", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Boolean indicating if the user is allowed to start more chats." + }, + { + "key": "per_tag", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ReturnActiveChatCountPerTag" + } + } + } + }, + "description": "Optional List of chat counts per tag." + } + ] + } + }, + "type_:ReturnActiveChatCountPerTag": { + "name": "ReturnActiveChatCountPerTag", + "description": "A description of current chat chat sessions per tag", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "tag", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "User tag applied to a chat." + }, + { + "key": "total_tag_active_chats", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of active chats for this user with the specified tag." + } + ] + } + }, + "type_:ReturnChatGroupPagedEvents": { + "name": "ReturnChatGroupPagedEvents", + "description": "A paginated list of chat events that occurred across chats in this chat_group from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID." + }, + { + "key": "page_number", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results returned per page." + }, + { + "key": "pagination_direction", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The direction of the pagination (ASC or DESC)." + }, + { + "key": "events_page", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnChatEvent" + } + }, + "description": "List of chat_events returned for the specified page number and page size." + } + ] + } + }, + "type_:ReturnChatGroupPagedChats": { + "name": "ReturnChatGroupPagedChats", + "description": "A description of chat_group and its status with a paginated list of each chat in the chat_group", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID." + }, + { + "key": "first_start_timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the first chat in this chat group started, formatted as a Unix epoch milliseconds." + }, + { + "key": "most_recent_start_timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the most recent chat in this chat group started, formatted as a Unix epoch milliseconds." + }, + { + "key": "num_chats", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of chats in this chat group." + }, + { + "key": "page_number", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results returned per page." + }, + { + "key": "chats_page", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnChat" + } + }, + "description": "List of chats and their metadata returned for the specified page number and page size." + }, + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ReturnChatGroup": { + "name": "ReturnChatGroup", + "description": "A description of chat_group and its status", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID." + }, + { + "key": "first_start_timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the first chat in this chat group started, formatted as a Unix epoch milliseconds." + }, + { + "key": "most_recent_start_timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The timestamp when the most recent chat in this chat group started, formatted as a Unix epoch milliseconds." + }, + { + "key": "most_recent_chat_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The chat_id of the most recent chat in this chat group. Formatted as a UUID." + }, + { + "key": "num_chats", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The total number of chats in this chat group." + }, + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ReturnPagedChatGroups": { + "name": "ReturnPagedChatGroups", + "description": "A paginated list of chat_groups returned from the server", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "page_number", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The page number of the returned results." + }, + { + "key": "page_size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of results returned per page." + }, + { + "key": "chat_groups_page", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ReturnChatGroup" + } + }, + "description": "List of chat_groups and their metadata returned for the specified page number and page size." + } + ] + } + }, + "type_:AssistantEnd": { + "name": "AssistantEnd", + "description": "When provided, the output is an assistant end message.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "assistant_end" + } + }, + "description": "The type of message sent through the socket; for an Assistant End message, this must be 'assistant_end'." + } + ] + } + }, + "type_:AssistantInput": { + "name": "AssistantInput", + "description": "When provided, the input is spoken by EVI.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Text to be synthesized." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "assistant_input" + } + }, + "description": "The type of message sent through the socket; for an Assistant Input message, this must be 'assistant_input'." + } + ] + } + }, + "type_:AssistantMessage": { + "name": "AssistantMessage", + "description": "When provided, the output is an assistant message.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "from_text", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Indicates if this message was constructed from a text input message." + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the assistant message." + }, + { + "key": "message", + "valueShape": { + "type": "id", + "id": "type_:ChatMessage" + }, + "description": "Transcript of the message." + }, + { + "key": "models", + "valueShape": { + "type": "id", + "id": "type_:Inference" + }, + "description": "Inference model results." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "assistant_message" + } + }, + "description": "The type of message sent through the socket; for an Assistant Message, this must be 'assistant_message'." + } + ] + } + }, + "type_:AudioConfiguration": { + "name": "AudioConfiguration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "channels", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of channels." + }, + { + "key": "encoding", + "valueShape": { + "type": "id", + "id": "type_:Encoding" + }, + "description": "Audio encoding." + }, + { + "key": "sample_rate", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Audio sample rate." + } + ] + } + }, + "type_:AudioInput": { + "name": "AudioInput", + "description": "When provided, the input is audio.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "data", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Base64 encoded audio input." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "audio_input" + } + }, + "description": "The type of message sent through the socket; for an Audio Input message, this must be 'audio_input'." + } + ] + } + }, + "type_:AudioOutput": { + "name": "AudioOutput", + "description": "When provided, the output is audio.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "data", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Base64 encoded audio output." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the audio output." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "audio_output" + } + }, + "description": "The type of message sent through the socket; for an Audio Output message, this must be 'audio_output'." + } + ] + } + }, + "type_:BuiltInTool": { + "name": "BuiltInTool", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "web_search" + } + } + } + }, + "type_:BuiltinToolConfig": { + "name": "BuiltinToolConfig", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fallback_content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:BuiltInTool" + } + } + ] + } + }, + "type_:ChatMessageToolResult": { + "name": "ChatMessageToolResult", + "description": "Function call response from client.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Tool Response Message", + "shape": { + "type": "id", + "id": "type_:ToolResponseMessage" + } + }, + { + "displayName": "Tool Error Message", + "shape": { + "type": "id", + "id": "type_:ToolErrorMessage" + } + } + ] + } + }, + "type_:ChatMessage": { + "name": "ChatMessage", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "id", + "id": "type_:Role" + }, + "description": "Role of who is providing the message." + }, + { + "key": "tool_call", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolCallMessage" + } + } + }, + { + "key": "tool_result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ChatMessageToolResult" + } + }, + "description": "Function call response from client." + } + ] + } + }, + "type_:ChatMetadata": { + "name": "ChatMetadata", + "description": "When provided, the output is a chat metadata message.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "chat_group_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the chat group. Used to resume a chat." + }, + { + "key": "chat_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the chat." + }, + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "chat_metadata" + } + }, + "description": "The type of message sent through the socket; for a Chat Metadata message, this must be 'chat_metadata'." + } + ] + } + }, + "type_:Context": { + "name": "Context", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "User context to inject." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ContextType" + } + }, + "description": "The persistence level of the injected context." + } + ] + } + }, + "type_:ContextType": { + "name": "ContextType", + "shape": { + "type": "enum", + "values": [ + { + "value": "editable" + }, + { + "value": "persistent" + }, + { + "value": "temporary" + } + ] + } + }, + "type_:EmotionScores": { + "name": "EmotionScores", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "Admiration", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Adoration", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Aesthetic Appreciation", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Amusement", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Anger", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Anxiety", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Awe", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Awkwardness", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Boredom", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Calmness", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Concentration", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Confusion", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Contemplation", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Contempt", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Contentment", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Craving", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Desire", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Determination", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Disappointment", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Disgust", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Distress", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Doubt", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Ecstasy", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Embarrassment", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Empathic Pain", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Entrancement", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Envy", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Excitement", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Fear", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Guilt", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Horror", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Interest", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Joy", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Love", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Nostalgia", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Pain", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Pride", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Realization", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Relief", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Romance", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Sadness", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Satisfaction", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Shame", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Surprise (negative)", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Surprise (positive)", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Sympathy", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Tiredness", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Triumph", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + ] + } + }, + "type_:Encoding": { + "name": "Encoding", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "linear16" + } + } + } + }, + "type_:WebSocketError": { + "name": "WebSocketError", + "description": "When provided, the output is an error message.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Error code." + }, + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Error message." + }, + { + "key": "slug", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Error slug." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "error" + } + }, + "description": "The type of message sent through the socket; for a Web Socket Error message, this must be 'error'." + } + ] + } + }, + "type_:ErrorLevel": { + "name": "ErrorLevel", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "warn" + } + } + } + }, + "type_:Inference": { + "name": "Inference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "prosody", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProsodyInference" + } + } + } + ] + } + }, + "type_:MillisecondInterval": { + "name": "MillisecondInterval", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "begin", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Start time of the interval in milliseconds." + }, + { + "key": "end", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "End time of the interval in milliseconds." + } + ] + } + }, + "type_:PauseAssistantMessage": { + "name": "PauseAssistantMessage", + "description": "Pause responses from EVI. Chat history is still saved and sent after resuming.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "pause_assistant_message" + } + } + }, + "description": "The type of message sent through the socket; for a Pause Assistant message, this must be 'pause_assistant_message'." + } + ] + } + }, + "type_:ProsodyInference": { + "name": "ProsodyInference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "scores", + "valueShape": { + "type": "id", + "id": "type_:EmotionScores" + } + } + ] + } + }, + "type_:ResumeAssistantMessage": { + "name": "ResumeAssistantMessage", + "description": "Resume responses from EVI. Chat history sent while paused will now be sent.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "resume_assistant_message" + } + } + }, + "description": "The type of message sent through the socket; for a Resume Assistant message, this must be 'resume_assistant_message'." + } + ] + } + }, + "type_:Role": { + "name": "Role", + "shape": { + "type": "enum", + "values": [ + { + "value": "assistant" + }, + { + "value": "system" + }, + { + "value": "user" + }, + { + "value": "all" + }, + { + "value": "tool" + } + ] + } + }, + "type_:SessionSettings": { + "name": "SessionSettings", + "description": "Settings for this chat session.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "audio", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AudioConfiguration" + } + } + }, + { + "key": "builtin_tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BuiltinToolConfig" + } + } + } + }, + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "language_model_api_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "system_prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "tools", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Tool" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "session_settings" + } + }, + "description": "The type of message sent through the socket; for a Session Settings message, this must be 'session_settings'." + } + ] + } + }, + "type_:Tool": { + "name": "Tool", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "fallback_content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the tool." + }, + { + "key": "parameters", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Parameters of the tool. Is a stringified JSON schema." + }, + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:ToolType" + }, + "description": "Type of tool." + } + ] + } + }, + "type_:ToolCallMessage": { + "name": "ToolCallMessage", + "description": "When provided, the output is a tool call.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the tool called." + }, + { + "key": "parameters", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Parameters of the tool call. Is a stringified JSON schema." + }, + { + "key": "response_required", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Whether a response is required from the developer." + }, + { + "key": "tool_call_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the tool call." + }, + { + "key": "tool_type", + "valueShape": { + "type": "id", + "id": "type_:ToolType" + }, + "description": "Type of tool called, either 'builtin' or 'function'." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "tool_call" + } + } + }, + "description": "The type of message sent through the socket; for a Tool Call message, this must be 'tool_call'." + } + ] + } + }, + "type_:ToolErrorMessage": { + "name": "ToolErrorMessage", + "description": "When provided, the output is a function call error.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "error", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Error message from the tool call, not exposed to the LLM or user." + }, + { + "key": "level", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ErrorLevel" + } + } + }, + { + "key": "tool_call_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the tool call." + }, + { + "key": "tool_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolType" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "tool_error" + } + } + }, + "description": "The type of message sent through the socket; for a Tool Error message, this must be 'tool_error'." + } + ] + } + }, + "type_:ToolResponseMessage": { + "name": "ToolResponseMessage", + "description": "When provided, the output is a function call response.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Return value of the tool call." + }, + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "tool_call_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the tool call." + }, + { + "key": "tool_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "tool_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ToolType" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "tool_response" + } + } + }, + "description": "The type of message sent through the socket; for a Tool Response message, this must be ‘tool_response’." + } + ] + } + }, + "type_:ToolType": { + "name": "ToolType", + "shape": { + "type": "enum", + "values": [ + { + "value": "builtin" + }, + { + "value": "function" + } + ] + } + }, + "type_:UserInput": { + "name": "UserInput", + "description": "User text to insert into the conversation.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "User text to insert into the conversation." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "user_input" + } + }, + "description": "The type of message sent through the socket; for a User Input message, this must be ‘user_input’." + } + ] + } + }, + "type_:UserInterruption": { + "name": "UserInterruption", + "description": "When provided, the output is an interruption.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "time", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Unix timestamp of the detected user interruption." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "user_interruption" + } + }, + "description": "The type of message sent through the socket; for a User Interruption message, this must be 'user_interruption'." + } + ] + } + }, + "type_:UserMessage": { + "name": "UserMessage", + "description": "When provided, the output is a user message.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "custom_session_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "from_text", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Indicates if this message was constructed from a text input message." + }, + { + "key": "message", + "valueShape": { + "type": "id", + "id": "type_:ChatMessage" + }, + "description": "Transcript of the message." + }, + { + "key": "models", + "valueShape": { + "type": "id", + "id": "type_:Inference" + }, + "description": "Inference model results." + }, + { + "key": "time", + "valueShape": { + "type": "id", + "id": "type_:MillisecondInterval" + }, + "description": "Start and End time of user message." + }, + { + "key": "type", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "user_message" + } + } + } + ] + } + }, + "type_:TtsInput": { + "name": "TtsInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "tts" + } + } + } + } + ] + } + }, + "type_:TextInput": { + "name": "TextInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "text_input" + } + } + } + } + ] + } + }, + "type_:FunctionCallResponseInput": { + "name": "FunctionCallResponseInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "function_call_response" + } + } + } + } + ] + } + } + }, + "subpackages": { + "subpackage_tools": { + "id": "subpackage_tools", + "name": "tools" + }, + "subpackage_prompts": { + "id": "subpackage_prompts", + "name": "prompts" + }, + "subpackage_configs": { + "id": "subpackage_configs", + "name": "configs" + }, + "subpackage_chats": { + "id": "subpackage_chats", + "name": "chats" + }, + "subpackage_chatGroups": { + "id": "subpackage_chatGroups", + "name": "chatGroups" + }, + "subpackage_chat": { + "id": "subpackage_chat", + "name": "chat" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-Hume-Api-Key", + "nameOverride": "apiKey" + } + } + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/node.json b/packages/fdr-sdk/src/__test__/output/hume/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/node.json rename to packages/fdr-sdk/src/__test__/output/hume/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/hume/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/hume/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/hume/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/hume/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/pageIds.json b/packages/fdr-sdk/src/__test__/output/hume/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/pageIds.json rename to packages/fdr-sdk/src/__test__/output/hume/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/sitemap.json b/packages/fdr-sdk/src/__test__/output/hume/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/sitemap.json rename to packages/fdr-sdk/src/__test__/output/hume/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/hume/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/hume/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/hume/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/hume/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/slugs.json b/packages/fdr-sdk/src/__test__/output/hume/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/slugs.json rename to packages/fdr-sdk/src/__test__/output/hume/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/hume/versionNodes.json b/packages/fdr-sdk/src/__test__/output/hume/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/hume/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/hume/versionNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/apiDefinitions.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/apiDefinitions.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/node.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/node.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/pageIds.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/pageIds.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/sitemap.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/sitemap.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/slugs.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/slugs.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/versionNodes.json b/packages/fdr-sdk/src/__test__/output/no-version-no-tabs/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-no-tabs/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/no-version-no-tabs/versionNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/versionNodes.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/apiDefinitions.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/apiDefinitions.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/node.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/node.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/pageIds.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/pageIds.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/sitemap.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/sitemap.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/slugs.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/no-version-yes-tabs/slugs.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/versionNodes.json b/packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/no-version-yes-tabs/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-270fcb14-fecb-45b5-8075-3e207a0d4b31.json b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-270fcb14-fecb-45b5-8075-3e207a0d4b31.json new file mode 100644 index 0000000000..205c4a19b6 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-270fcb14-fecb-45b5-8075-3e207a0d4b31.json @@ -0,0 +1,1080 @@ +[ + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/is_public", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/data_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/asset_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/engine_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/limit", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/offset", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/get_preview_urls", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/asset_ids", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/query/owner", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/asset_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/data", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/description", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/hf_repo", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/hf_token_secret", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/is_public", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/skip_validation", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/transfer_api_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object/property/url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/path/asset_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/path/asset_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/request/object/property/skip_validation", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/request/object/property/token", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/path/asset_owner_and_name_or_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/query/transfer_api_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/request/object/property/continue_on_rejection", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/request/object/property/description", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/request/object/property/details", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/request/object/property/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/path/tune_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/path/tune_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/path/tune_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/query/offset", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/query/limit", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/query/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/query/tune_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/query/base_checkpoint_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/query/trigger_words", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/query/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/image", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/height", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/width", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/cfg_scale", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/steps", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/motion_scale", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/noise_aug_strength", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/num_videos", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/fps", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/seed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/enable_safety", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/force_asset_download", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object/property/force_asset_gpu_copy", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/frequency_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/ignore_eos", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/logit_bias", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/loglikelihood", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/max_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/messages", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/n", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/octoai", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/presence_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/repetition_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/response_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/stop", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/stream", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/stream_options", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/temperature", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/top_logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/top_p", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object/property/user", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/error/1/500/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/2/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/2/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/2/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/frequency_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/ignore_eos", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/logit_bias", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/loglikelihood", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/max_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/messages", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/n", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/octoai", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/presence_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/repetition_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/response_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/stop", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/stream", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/stream_options", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/temperature", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/top_logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/top_p", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object/property/user", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/error/1/500/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/2/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/2/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/2/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/best_of", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/echo", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/frequency_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/logit_bias", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/loglikelihood", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/max_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/n", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/presence_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/prompt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/repetition_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/seed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/stop", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/stream", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/stream_options", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/suffix", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/temperature", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/top_p", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object/property/user", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/error/1/500/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/2/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/2/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/2/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/best_of", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/echo", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/frequency_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/logit_bias", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/loglikelihood", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/max_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/n", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/presence_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/prompt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/repetition_penalty", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/seed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/stop", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/stream", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/stream_options", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/suffix", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/temperature", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/top_p", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object/property/user", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/error/1/500/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/0/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/0/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/0/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/1/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/1/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/1/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/2/snippet/curl/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/2/snippet/python/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/2/snippet/typescript/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/asset_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/created_at", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/data", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/description", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/file_structure", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/hf_repo", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/is_public", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/size_bytes", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/status", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/status_details", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/status_info", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/tenant_uuid", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object/property/url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType/shape/enum/value/file", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType/shape/enum/value/checkpoint", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType/shape/enum/value/lora", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType/shape/enum/value/textual_inversion", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType/shape/enum/value/vae", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType/shape/enum/value/latent", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/llama-2-7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/llama-2-13b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/llama-2-70b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/codellama-7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/codellama-13b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/codellama-34b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/codellama-70b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/mistral-7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/text/mixtral-8x7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/image/controlnet-sd15", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/image/controlnet-sdxl", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/image/stable-diffusion-v1-5", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/image/stable-diffusion-xl-v1-0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/image/stable-diffusion-ssd", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/audio/tortoise-tts", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape/enum/value/audio/rvc", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngineType/shape/enum/value/text", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngineType/shape/enum/value/image", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngineType/shape/enum/value/audio", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CheckpointData/shape/object/property/data_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CheckpointData/shape/object/property/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CheckpointData/shape/object/property/file_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CompleteAssetUploadResponse/shape/object/property/error", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponse/shape/object/property/asset", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponse/shape/object/property/token", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponse/shape/object/property/transfer_api", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DataType/shape/enum/value/fp16", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DataType/shape/enum/value/fp32", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DataType/shape/enum/value/int4", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DataType/shape/enum/value/int8", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DeleteAssetResponse/shape/object/property/deleted_at", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DeleteAssetResponse/shape/object/property/id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileData/shape/object/property/file_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileData/shape/object/property/preview_url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileData/shape/object/property/version", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape/enum/value/unknown", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape/enum/value/png", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape/enum/value/jpg", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape/enum/value/jpeg", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape/enum/value/txt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape/enum/value/mp3", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape/enum/value/wav", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileFormat/shape/enum/value/safetensors", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileFormat/shape/enum/value/pt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileStructure/shape/enum/value/unknown", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileStructure/shape/enum/value/single_file", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileStructure/shape/enum/value/multiple_files", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:HTTPValidationError/shape/object/property/detail", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LatentData/shape/object/property/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LatentData/shape/object/property/file_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ListAssetsResponse/shape/object/property/data", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ListAssetsResponse/shape/object/property/has_more", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ListAssetsResponse/shape/object/property/total", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData/shape/object/property/checkpoint", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData/shape/object/property/data_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData/shape/object/property/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData/shape/object/property/file_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData/shape/object/property/trigger_words", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:PresignedUrlTransferApi/shape/object/property/get_url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:PresignedUrlTransferApi/shape/object/property/put_url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponse/shape/object/property/asset", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponse/shape/object/property/transfer_api", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape/enum/value/ready_to_upload", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape/enum/value/uploaded", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape/enum/value/ready", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape/enum/value/deleted", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape/enum/value/rejected", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape/enum/value/error", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape/enum/value/uploading", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object/property/aws_access_key_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object/property/aws_secret_access_key", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object/property/aws_session_token", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object/property/s3_bucket", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object/property/s3_endpoint_url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object/property/s3_key", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object/property/s3_url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TextualInversionData/shape/object/property/data_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TextualInversionData/shape/object/property/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TextualInversionData/shape/object/property/file_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TextualInversionData/shape/object/property/trigger_words", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TransferApiType/shape/enum/value/presigned-url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TransferApiType/shape/enum/value/sts", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:VAEData/shape/object/property/data_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:VAEData/shape/object/property/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:VAEData/shape/object/property/file_format", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationError/shape/object/property/loc", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationError/shape/object/property/msg", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationError/shape/object/property/type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/llama-2-7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/llama-2-13b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/llama-2-70b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/codellama-7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/codellama-13b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/codellama-34b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/codellama-70b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/mistral-7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/text/mixtral-8x7b", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/image/controlnet-sd15", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/image/controlnet-sdxl", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/image/stable-diffusion-v1-5", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/image/stable-diffusion-xl-v1-0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/image/stable-diffusion-ssd", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/audio/tortoise-tts", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape/enum/value/audio/rvc", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:HTTPValidationError/shape/object/property/detail", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ListTunesResponse/shape/object/property/data", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ListTunesResponse/shape/object/property/has_more", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ListTunesResponse/shape/object/property/total", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape/object/property/base_checkpoint", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape/object/property/files", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape/object/property/resize_images", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape/object/property/seed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape/object/property/steps", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape/object/property/trigger_words", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneCheckpoint/shape/object/property/checkpoint_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneCheckpoint/shape/object/property/engine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneCheckpoint/shape/object/property/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneFile/shape/object/property/caption", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneFile/shape/object/property/file_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TextToSpeechLatentTune/shape/object/property/asset_ids", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TextToSpeechLatentTune/shape/object/property/inline_assets", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/created_at", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/deleted_at", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/description", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/details", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/output_lora_ids", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/result", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/status", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/status_details", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/succeeded_at", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/tenant_id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/tune_type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object/property/updated_at", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneResult/shape/object/property/number_of_available_assets", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneResult/shape/object/property/output_assets", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneResult/shape/object/property/rejected_assets", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneResult/shape/object/property/unready_assets", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneStatus/shape/enum/value/pending", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneStatus/shape/enum/value/running", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneStatus/shape/enum/value/succeeded", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneStatus/shape/enum/value/cancelled", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneStatus/shape/enum/value/failed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneType/shape/enum/value/lora_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneType/shape/enum/value/text_to_speech_latent_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneType/shape/enum/value/text_to_speech_rvc_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneType/shape/enum/value/text_to_speech_tortoise_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationError/shape/object/property/loc", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationError/shape/object/property/msg", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationError/shape/object/property/type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationRequestSeed/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationRequestSeed/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:HTTPValidationError/shape/object/property/detail", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageEncoding/shape/enum/value/jpeg", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageEncoding/shape/enum/value/png", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGeneration/shape/object/property/image_b64", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGeneration/shape/object/property/removed_for_safety", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGeneration/shape/object/property/seed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGeneration/shape/object/property/safety_score", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequestSeed/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequestSeed/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/prompt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/prompt_2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/negative_prompt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/negative_prompt_2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/checkpoint", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/controlnet", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/vae", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/textual_inversions", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/loras", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/sampler", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/height", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/width", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/cfg_scale", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/steps", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/num_images", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/seed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/controlnet_image", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/init_image", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/mask_image", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/strength", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/style_preset", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/use_refiner", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/high_noise_frac", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/controlnet_conditioning_scale", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/controlnet_early_stop", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/controlnet_preprocess", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/clip_skip", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/outpainting", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/enable_safety", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/image_encoding", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/transfer_images", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/force_asset_download", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object/property/force_asset_gpu_copy", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationResponse/shape/object/property/images", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationResponse/shape/object/property/prediction_time_ms", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/base", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/3d-model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/analog-film", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/anime", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/cinematic", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/comic-book", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Craft Clay", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/modeling-compound", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/digital-art", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/enhance", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/fantasy-art", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/isometric", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/line-art", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/low-poly", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/neon-punk", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/origami", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/photographic", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/pixel-art", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/tile-texture", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Advertising", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Food Photography", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Real Estate", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Abstract", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Cubist", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Graffiti", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Hyperrealism", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Impressionist", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Pointillism", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Pop Art", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Psychedelic", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Renaissance", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Steampunk", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Surrealist", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Typography", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Watercolor", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Fighting Game", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/GTA", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Super Mario", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Minecraft", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Pokémon", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Retro Arcade", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Retro Game", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/RPG Fantasy Game", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Strategy Game", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Street Fighter", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Legend of Zelda", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Architectural", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Disco", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Dreamscape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Dystopian", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Fairy Tale", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Gothic", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Grunge", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Horror", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Minimalist", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Monochrome", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Nautical", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Space", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Stained Glass", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Techwear Fashion", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Tribal", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Zentangle", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Collage", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Flat Papercut", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Kirigami", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Paper Mache", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Paper Quilling", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Papercut Collage", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Papercut Shadow Box", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Stacked Papercut", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Thick Layered Papercut", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Alien", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Film Noir", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/HDR", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Long Exposure", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Neon Noir", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Silhouette", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape/enum/value/Tilt-Shift", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/PNDM", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/LMS", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/KLMS", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DDIM", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DDPM", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/HEUN", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/K_HEUN", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/K_EULER", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/K_EULER_ANCESTRAL", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DPM_SOLVER_MULTISTEP", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DPM_PLUS_PLUS_2M_KARRAS", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DPM_SINGLE", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DPM_2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DPM_2_ANCESTRAL", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/DPM_PLUS_PLUS_SDE_KARRAS", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/UNI_PC", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape/enum/value/LCM", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationError/shape/object/property/loc", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationError/shape/object/property/msg", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationError/shape/object/property/type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGeneration/shape/object/property/video", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGeneration/shape/object/property/removed_for_safety", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGeneration/shape/object/property/seed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGeneration/shape/object/property/safety_score", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationResponse/shape/object/property/videos", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationResponse/shape/object/property/prediction_time_ms", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Stop/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Stop/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Prompt/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Prompt/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Prompt/shape/undiscriminatedUnion/variant/2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Prompt/shape/undiscriminatedUnion/variant/3", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChoice/shape/object/property/finish_reason", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChoice/shape/object/property/index", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChoice/shape/object/property/logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChoice/shape/object/property/message", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape/object/property/choices", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape/object/property/created", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape/object/property/id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape/object/property/model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape/object/property/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape/object/property/usage", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunkChoice/shape/object/property/delta", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunkChoice/shape/object/property/finish_reason", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunkChoice/shape/object/property/index", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunkChoice/shape/object/property/logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionDelta/shape/object/property/content", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionDelta/shape/object/property/role", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExt/shape/object/property/vllm", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape/object/property/best_of", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape/object/property/ignore_eos", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape/object/property/skip_special_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape/object/property/stop_token_ids", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape/object/property/top_k", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape/object/property/use_beam_search", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape/object/property/choices", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape/object/property/created", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape/object/property/id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape/object/property/model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape/object/property/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape/object/property/usage", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponseFormat/shape/object/property/schema", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponseFormat/shape/object/property/type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatMessage/shape/object/property/content", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatMessage/shape/object/property/role", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionChoice/shape/object/property/finish_reason", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionChoice/shape/object/property/index", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionChoice/shape/object/property/logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionChoice/shape/object/property/text", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object/property/choices", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object/property/created", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object/property/id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object/property/model", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object/property/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object/property/system_fingerprint", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object/property/usage", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponseValidationErrorsValue/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponseValidationErrorsValue/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape/object/property/code", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape/object/property/message", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape/object/property/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape/object/property/param", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape/object/property/type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape/object/property/validation_errors", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason/shape/enum/value/stop", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason/shape/enum/value/length", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason/shape/enum/value/tool_calls", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason/shape/enum/value/content_filter", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason/shape/enum/value/function_call", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason/shape/enum/value/cancelled", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FunctionCall/shape/object/property/arguments", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FunctionCall/shape/object/property/name", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:HTTPValidationError/shape/object/property/detail", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Logprobs/shape/object/property/content", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:LogprobsContent/shape/object/property/bytes", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:LogprobsContent/shape/object/property/logprob", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:LogprobsContent/shape/object/property/token", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:LogprobsContent/shape/object/property/top_logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:StreamOptions/shape/object/property/include_usage", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ToolCall/shape/object/property/function", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ToolCall/shape/object/property/id", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ToolCall/shape/object/property/type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:TopLogprobs/shape/object/property/bytes", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:TopLogprobs/shape/object/property/logprob", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:TopLogprobs/shape/object/property/token", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:UsageStats/shape/object/property/completion_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:UsageStats/shape/object/property/prompt_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:UsageStats/shape/object/property/total_tokens", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationError/shape/object/property/loc", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationError/shape/object/property/msg", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationError/shape/object/property/type", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/response/stream/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/error/1/500/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/error/1/500/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/response/stream/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/error/1/500/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/error/0/422/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/error/1/500/error/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data/shape/discriminatedUnion/variant/checkpoint", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data/shape/discriminatedUnion/variant/file", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data/shape/discriminatedUnion/variant/latent", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data/shape/discriminatedUnion/variant/lora", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data/shape/discriminatedUnion/variant/textual_inversion", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data/shape/discriminatedUnion/variant/vae", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponseTransferApi/shape/discriminatedUnion/variant/none", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponseTransferApi/shape/discriminatedUnion/variant/presigned-url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponseTransferApi/shape/discriminatedUnion/variant/sts", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:NoTransferApi/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponseTransferApi/shape/discriminatedUnion/variant/none", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponseTransferApi/shape/discriminatedUnion/variant/presigned-url", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponseTransferApi/shape/discriminatedUnion/variant/sts", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Details/shape/discriminatedUnion/variant/lora_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Details/shape/discriminatedUnion/variant/text_to_speech_latent_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneDetails/shape/discriminatedUnion/variant/lora_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneDetails/shape/discriminatedUnion/variant/text_to_speech_latent_tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CheckpointData/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CompleteAssetUploadResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DeleteAssetResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileData/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:HTTPValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LatentData/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ListAssetsResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:PresignedUrlTransferApi/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TextualInversionData/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:VAEData/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:HTTPValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ListTunesResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneCheckpoint/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneFile/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TextToSpeechLatentTune/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneResult/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:HTTPValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGeneration/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGeneration/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChoice/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunkChoice/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionDelta/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExt/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponseFormat/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatMessage/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionChoice/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FunctionCall/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:HTTPValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Logprobs/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:LogprobsContent/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:StreamOptions/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ToolCall/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:TopLogprobs/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:UsageStats/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationError/shape/object", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngineType/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DataType/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileFormat/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileStructure/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TransferApiType/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationErrorLocItem/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneStatus/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneType/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationErrorLocItem/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationRequestSeed/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageEncoding/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequestSeed/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationErrorLocItem/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Stop/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Prompt/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponseValidationErrorsValue/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationErrorLocItem/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/error/1/500", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/example/2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/error/1/500", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/example/2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/response", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/error/1/500", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/example/2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/error/0/422", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/error/1/500", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/0", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/1", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/example/2", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:NoTransferApi/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion/request", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:AssetType", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:BaseEngineType", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CheckpointData/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CompleteAssetUploadResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponseTransferApi/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DataType", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DeleteAssetResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileData/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileExtension", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileFormat", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileStructure", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:HTTPValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LatentData/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ListAssetsResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:PresignedUrlTransferApi/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponseTransferApi/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Status", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TextualInversionData/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TransferApiType", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:VAEData/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationErrorLocItem", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Details/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:BaseEngine", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:HTTPValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ListTunesResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneCheckpoint/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneFile/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TextToSpeechLatentTune/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneDetails/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneResult/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneStatus", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneType", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationErrorLocItem", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationRequestSeed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:HTTPValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageEncoding", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGeneration/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequestSeed", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:SDXLStyles", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:Scheduler", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationErrorLocItem", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGeneration/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Stop", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Prompt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChoice/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunkChoice/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionDelta/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExt/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponseFormat/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatMessage/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionChoice/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponseValidationErrorsValue", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FinishReason", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FunctionCall/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:HTTPValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Logprobs/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:LogprobsContent/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:StreamOptions/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ToolCall/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:TopLogprobs/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:UsageStats/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationErrorLocItem", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationError/shape", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:NoTransferApi", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Data", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:Asset", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CheckpointData", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CompleteAssetUploadResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponseTransferApi", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:CreateAssetResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:DeleteAssetResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:FileData", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:HTTPValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LatentData", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ListAssetsResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:LoraData", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:PresignedUrlTransferApi", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponseTransferApi", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:RetrieveAssetResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:StsTransferApi", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:TextualInversionData", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:VAEData", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_asset-library:ValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Details", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:HTTPValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ListTunesResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneCheckpoint", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:LoraTuneFile", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TextToSpeechLatentTune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneDetails", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:Tune", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:TuneResult", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_fine-tuning:ValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:HTTPValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGeneration", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationRequest", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ImageGenerationResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:ValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGeneration", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_image-gen:VideoGenerationResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChoice", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunk", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionChunkChoice", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionDelta", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExt", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionRequestExtVLLM", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatCompletionResponseFormat", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ChatMessage", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionChoice", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:CompletionResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ErrorResponse", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:FunctionCall", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:HTTPValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:Logprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:LogprobsContent", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:StreamOptions", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ToolCall", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:TopLogprobs", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:UsageStats", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/type-definition/type_text-gen:ValidationError", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.list", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.create", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.delete", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.completeUpload", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_asset-library.get", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.create", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.get", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.delete", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.cancel", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_fine-tuning.list", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSsd", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSdxl", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateControlnetSd15", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSdxl", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSd", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_image-gen.generateSvd", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion_stream", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createChatCompletion", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion_stream", + "270fcb14-fecb-45b5-8075-3e207a0d4b31/endpoint/endpoint_text-gen.createCompletion" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-2eeac53f-90cc-492b-9d29-e3ed711d7704.json b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-2eeac53f-90cc-492b-9d29-e3ed711d7704.json new file mode 100644 index 0000000000..7a5147aa7c --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-2eeac53f-90cc-492b-9d29-e3ed711d7704.json @@ -0,0 +1,147 @@ +[ + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/face_enhance", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/init_image_url", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/init_image", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/model", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/output_image_height", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/output_image_width", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/output_image_encoding", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object/property/scale", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/example/0/snippet/curl/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/example/1/snippet/curl/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/init_image", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/init_image_url", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/output_image_encoding", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/alpha_matting", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/alpha_matting_foreground_threshold", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/alpha_matting_background_threshold", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/alpha_matting_erode_size", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/only_mask", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/post_process_mask", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object/property/bgcolor", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/example/0/snippet/curl/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/example/1/snippet/curl/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/init_image", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/init_image_url", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/image_encoding", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/transfer_images", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/prompt", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/negative_prompt", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/sampler", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/steps", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/inpainting_base_model", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/checkpoint", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/loras", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/use_refiner", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/style_preset", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/strength", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/cfg_scale", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/seed", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/mask_dilation", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/mask_blur", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/mask_padding", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/max_num_detections", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/confidence", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/detector", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object/property/union_masks", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/example/0/snippet/curl/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/example/1/snippet/curl/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerRequestSeed/shape/undiscriminatedUnion/variant/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerRequestSeed/shape/undiscriminatedUnion/variant/1", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape/enum/value/face_yolov8n", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape/enum/value/hand_yolov8n", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape/enum/value/face_full_mediapipe", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape/enum/value/face_short_mediapipe", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape/enum/value/face_mesh_mediapipe", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape/enum/value/eyes_mesh_mediapipe", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape/enum/value/face_hair_mediapipe", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerInpaintingBaseModel/shape/enum/value/sdxl", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerInpaintingBaseModel/shape/enum/value/sd15", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerResponse/shape/object/property/image_b64", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerResponse/shape/object/property/num_objects_inpainted", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerResponse/shape/object/property/num_objects_detected", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerResponse/shape/object/property/num_removed_for_safety", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:HTTPValidationError/shape/object/property/detail", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageEncoding/shape/enum/value/jpeg", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageEncoding/shape/enum/value/png", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageResponse/shape/object/property/image_b64", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageResponse/shape/object/property/removed_for_safety", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/PNDM", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/LMS", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/KLMS", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DDIM", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DDPM", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/HEUN", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/K_HEUN", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/K_EULER", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/K_EULER_ANCESTRAL", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DPM_SOLVER_MULTISTEP", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DPM_PLUS_PLUS_2M_KARRAS", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DPM_SINGLE", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DPM_2", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DPM_2_ANCESTRAL", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/DPM_PLUS_PLUS_SDE_KARRAS", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/UNI_PC", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape/enum/value/LCM", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel/shape/enum/value/real-esrgan-x4-plus", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel/shape/enum/value/real-esrgan-x4-v3", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel/shape/enum/value/real-esrgan-x4-v3-wdn", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel/shape/enum/value/real-esrgan-animevideo-v3", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel/shape/enum/value/real-esrgan-x4-plus-anime", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel/shape/enum/value/real-esrgan-x2-plus", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationErrorLocItem/shape/undiscriminatedUnion/variant/1", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationError/shape/object/property/loc", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationError/shape/object/property/msg", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationError/shape/object/property/type", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/response", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/error/0/422/error/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/response", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/error/0/422/error/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/response", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/error/0/422/error/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request/object", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request/object", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request/object", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerResponse/shape/object", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:HTTPValidationError/shape/object", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageResponse/shape/object", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationError/shape/object", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerRequestSeed/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerInpaintingBaseModel/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageEncoding/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationErrorLocItem/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/error/0/422", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/example/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/example/1", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/error/0/422", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/example/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/example/1", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/error/0/422", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/example/0", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/example/1", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale/request", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background/request", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images/request", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerRequestSeed", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerDetector", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerInpaintingBaseModel", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerResponse/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:HTTPValidationError/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageEncoding", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageResponse/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:Scheduler", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:UpscalingModel", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationErrorLocItem", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationError/shape", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ADetailerResponse", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:HTTPValidationError", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ImageResponse", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/type-definition/type_:ValidationError", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.upscale", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.remove_background", + "2eeac53f-90cc-492b-9d29-e3ed711d7704/endpoint/endpoint_.generate_images" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-cb786748-d42f-427d-9c21-00e6c59bd56c.json b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-cb786748-d42f-427d-9c21-00e6c59bd56c.json new file mode 100644 index 0000000000..e91e9f75f7 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitionKeys-cb786748-d42f-427d-9c21-00e6c59bd56c.json @@ -0,0 +1,338 @@ +[ + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.getAccount/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount/request/object/property/country", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount/request/object/property/company", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.createEndpoint/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoint/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoint/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.deleteEndpoint/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.deleteEndpoint/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.patchEndpoint/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.patchEndpoint/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoints/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getContainerMetadata/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getContainerMetadata/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpointVolumeToken/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpointVolumeToken/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/query/begin_time", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/query/end_time", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/query/max_lines", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/query/replica_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogsStream/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogsStream/query/replica_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogsStream/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/query/begin_time", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/query/end_time", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/query/max_lines", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/query/replica_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEventsStream/path/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEventsStream/query/replica_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEventsStream/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.createSecret/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecret/path/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecret/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret/path/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret/request/object/property/value", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.deleteSecret/path/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.deleteSecret/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecrets/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.createRegistryCredential/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredential/path/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredential/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/path/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/request/object/property/username", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/request/object/property/password", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.deleteRegistryCredential/path/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.deleteRegistryCredential/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredentials/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_publicEndpoint.getPublicEndpoints/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_instanceTypes.getInstanceTypes/example/0/snippet/curl/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_endpoint:EndpointDeleteEndpointResponse/shape/object/property/message", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_secret:SecretDeleteSecretResponse/shape/object/property/message", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_registryCredential:RegistryCredentialDeleteRegistryCredentialResponse/shape/object/property/message", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AccountStatus/shape/enum/value/ready_trial", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AccountStatus/shape/enum/value/ready_billed", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AccountStatus/shape/enum/value/suspended_billing", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AccountStatus/shape/enum/value/suspended_tos", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AccountStatus/shape/enum/value/error", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object/property/name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object/property/email", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object/property/provider", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object/property/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object/property/country", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object/property/company", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object/property/status", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateVisibility/shape/enum/value/private", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateVisibility/shape/enum/value/public", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateEndpointState/shape/enum/value/active", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateEndpointState/shape/enum/value/disabled", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/min_replicas", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/max_replicas", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/scale_to_zero", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/display_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/description", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/image_url", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/registry_credential", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/health_check_path", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/visibility", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/endpoint_state", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/env_overrides", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/instance_type", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/container_secrets", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object/property/concurrency_per_replica", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/display_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/description", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/port", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/health_check_path", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/auto_volume_experimental", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/volumes_experimental", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/min_replicas", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/max_replicas", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/scale_to_zero", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/image_url", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/registry_credential", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/visibility", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/endpoint_state", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/env_overrides", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/instance_type", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/container_secrets", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object/property/concurrency_per_replica", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeExperimental/shape/object/property/name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeExperimental/shape/object/property/path", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeExperimental/shape/object/property/mount", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerPort/shape/object/property/port_num", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerPort/shape/object/property/proto", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerResponse/shape/object/property/image_url", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerResponse/shape/object/property/exposed_ports", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerResponse/shape/object/property/labels", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerResponse/shape/object/property/env", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeToken/shape/object/property/token", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:SecretKeyValue/shape/object/property/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:SecretKeyValue/shape/object/property/value", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredential/shape/object/property/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredential/shape/object/property/username", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredential/shape/object/property/password", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredentialSummary/shape/object/property/key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredentialSummary/shape/object/property/username", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AggregationEnum/shape/enum/value/1m", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AggregationEnum/shape/enum/value/30m", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AggregationEnum/shape/enum/value/1h", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AggregationEnum/shape/enum/value/24h", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object/property/count_2xx", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object/property/count_3xx", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object/property/count_4xx", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object/property/count_5xx", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object/property/p99_millis", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object/property/p95_millis", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object/property/p50_millis", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventEntry/shape/object/property/timestamp", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventEntry/shape/object/property/replica_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventEntry/shape/object/property/event", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventLevel/shape/enum/value/normal", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventLevel/shape/enum/value/warning", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object/property/level", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object/property/type", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object/property/endpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object/property/tenant_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object/property/account_key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object/property/instance_type", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object/property/details", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:LogEntry/shape/object/property/timestamp", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:LogEntry/shape/object/property/replica_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:LogEntry/shape/object/property/data", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ReplicaStatus/shape/enum/value/pending", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ReplicaStatus/shape/enum/value/running", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ReplicaStatus/shape/enum/value/succeeded", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ReplicaStatus/shape/enum/value/failed", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ReplicaStatus/shape/enum/value/unknown", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape/object/property/account_key", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape/object/property/endpoint_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape/object/property/replica_id", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape/object/property/status", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape/object/property/restarts", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape/object/property/age", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointResponse/shape/object/property/endpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointResponse/shape/object/property/replicas", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:HostedEndpoint/shape/object/property/endpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:HostedEndpoint/shape/object/property/is_live", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfoAccelerator/shape/enum/value/none", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfoAccelerator/shape/enum/value/gpu", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/instance_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/display_name", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/vcpu", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/ram", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/vram", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/accelerator", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/available", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object/property/price", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.getAccount/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.createEndpoint/request", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.createEndpoint/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoint/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.deleteEndpoint/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.patchEndpoint/request", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.patchEndpoint/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoints/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getContainerMetadata/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpointVolumeToken/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogsStream/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEventsStream/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.createSecret/request", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.createSecret/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecret/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.deleteSecret/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecrets/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.createRegistryCredential/request", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.createRegistryCredential/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredential/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.deleteRegistryCredential/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredentials/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_publicEndpoint.getPublicEndpoints/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_instanceTypes.getInstanceTypes/response", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount/request/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret/request/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/request/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_endpoint:EndpointDeleteEndpointResponse/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_secret:SecretDeleteSecretResponse/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_registryCredential:RegistryCredentialDeleteRegistryCredentialResponse/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeExperimental/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerPort/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerResponse/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeToken/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:SecretKeyValue/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredential/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredentialSummary/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventEntry/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:LogEntry/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointResponse/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:HostedEndpoint/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape/object", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AccountStatus/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateVisibility/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateEndpointState/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AggregationEnum/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventLevel/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ReplicaStatus/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfoAccelerator/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.getAccount/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.createEndpoint/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoint/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.deleteEndpoint/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.patchEndpoint/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoints/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getContainerMetadata/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpointVolumeToken/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogsStream/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEventsStream/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.createSecret/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecret/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.deleteSecret/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecrets/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.createRegistryCredential/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredential/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.deleteRegistryCredential/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredentials/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_publicEndpoint.getPublicEndpoints/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_instanceTypes.getInstanceTypes/example/0", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount/request", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret/request", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential/request", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_endpoint:EndpointDeleteEndpointResponse/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_secret:SecretDeleteSecretResponse/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_registryCredential:RegistryCredentialDeleteRegistryCredentialResponse/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AccountStatus", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateVisibility", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdateEndpointState", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeExperimental/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerPort/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerResponse/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeToken/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:SecretKeyValue/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredential/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredentialSummary/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:AggregationEnum", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventEntry/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventLevel", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:LogEntry/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ReplicaStatus", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointResponse/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:HostedEndpoint/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfoAccelerator", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo/shape", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_endpoint:EndpointDeleteEndpointResponse", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_secret:SecretDeleteSecretResponse", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_registryCredential:RegistryCredentialDeleteRegistryCredentialResponse", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Account", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointUpdate", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointCreate", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeExperimental", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerPort", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:ContainerResponse", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:VolumeToken", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:SecretKeyValue", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredential", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:RegistryCredentialSummary", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:MetricEntry", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EventEntry", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Event", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:LogEntry", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:Replica", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:EndpointResponse", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:HostedEndpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/type-definition/type_:InstanceTypeInfo", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.getAccount", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_account.patchAccount", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.createEndpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.deleteEndpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.patchEndpoint", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpoints", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getContainerMetadata", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_endpoint.getEndpointVolumeToken", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogs", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointLogsStream", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEvents", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_telemetry.getEndpointEventsStream", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.createSecret", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecret", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.updateSecret", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.deleteSecret", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_secret.getSecrets", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.createRegistryCredential", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredential", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.updateRegistryCredential", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.deleteRegistryCredential", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_registryCredential.getRegistryCredentials", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_publicEndpoint.getPublicEndpoints", + "cb786748-d42f-427d-9c21-00e6c59bd56c/endpoint/endpoint_instanceTypes.getInstanceTypes" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitions.json new file mode 100644 index 0000000000..ebad369a0f --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/octoai/apiDefinitions.json @@ -0,0 +1,29241 @@ +[ + { + "id": "cb786748-d42f-427d-9c21-00e6c59bd56c", + "endpoints": { + "endpoint_account.getAccount": { + "id": "endpoint_account.getAccount", + "namespace": [ + "subpackage_account" + ], + "description": "Return fields on an account", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/account" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Account" + } + } + }, + "examples": [ + { + "path": "/v1/account", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "email": "email", + "provider": "provider", + "key": "key", + "status": "ready_trial", + "country": "country", + "company": "company" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/account \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_account.patchAccount": { + "id": "endpoint_account.patchAccount", + "namespace": [ + "subpackage_account" + ], + "description": "Update fields on account", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v1/account" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "country", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "company", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Account" + } + } + }, + "examples": [ + { + "path": "/v1/account", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "country": "country", + "company": "company" + } + }, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "email": "email", + "provider": "provider", + "key": "key", + "status": "ready_trial", + "country": "country", + "company": "company" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.octoai.cloud/v1/account \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"country\": \"country\",\n \"company\": \"company\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_endpoint.createEndpoint": { + "id": "endpoint_endpoint.createEndpoint", + "namespace": [ + "subpackage_endpoint" + ], + "description": "Create new endpoint", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/endpoint" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EndpointCreate" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EndpointResponse" + } + } + }, + "examples": [ + { + "path": "/v1/endpoint", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "name", + "port": 1, + "image_url": "image_url" + } + }, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "port": 1, + "replicas": [ + { + "account_key": "account_key", + "endpoint_name": "endpoint_name", + "replica_id": "replica_id", + "status": "pending", + "restarts": 1, + "age": 1 + } + ], + "auto_volume_experimental": true, + "concurrency_per_replica": 1, + "container_secrets": [ + "container_secrets" + ], + "description": "description", + "display_name": "display_name", + "endpoint": "endpoint", + "endpoint_state": "active", + "env_overrides": { + "env_overrides": { + "key": "value" + } + }, + "health_check_path": "health_check_path", + "image_url": "image_url", + "instance_type": "instance_type", + "max_replicas": 1, + "min_replicas": 1, + "registry_credential": "registry_credential", + "scale_to_zero": 1, + "visibility": "private", + "volumes_experimental": [ + { + "name": "name", + "path": "path", + "mount": "mount" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/endpoint \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"name\",\n \"port\": 1,\n \"image_url\": \"image_url\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_endpoint.getEndpoint": { + "id": "endpoint_endpoint.getEndpoint", + "namespace": [ + "subpackage_endpoint" + ], + "description": "Return description of an endpoint", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/endpoint/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint to retrieve" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EndpointResponse" + } + } + }, + "examples": [ + { + "path": "/v1/endpoint/endpoint_name", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "port": 1, + "replicas": [ + { + "account_key": "account_key", + "endpoint_name": "endpoint_name", + "replica_id": "replica_id", + "status": "pending", + "restarts": 1, + "age": 1 + } + ], + "auto_volume_experimental": true, + "concurrency_per_replica": 1, + "container_secrets": [ + "container_secrets" + ], + "description": "description", + "display_name": "display_name", + "endpoint": "endpoint", + "endpoint_state": "active", + "env_overrides": { + "env_overrides": { + "key": "value" + } + }, + "health_check_path": "health_check_path", + "image_url": "image_url", + "instance_type": "instance_type", + "max_replicas": 1, + "min_replicas": 1, + "registry_credential": "registry_credential", + "scale_to_zero": 1, + "visibility": "private", + "volumes_experimental": [ + { + "name": "name", + "path": "path", + "mount": "mount" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/endpoint/endpoint_name \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_endpoint.deleteEndpoint": { + "id": "endpoint_endpoint.deleteEndpoint", + "namespace": [ + "subpackage_endpoint" + ], + "description": "Delete an endpoint", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v1/endpoint/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint to delete" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_endpoint:EndpointDeleteEndpointResponse" + } + } + }, + "examples": [ + { + "path": "/v1/endpoint/endpoint_name", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "message" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.octoai.cloud/v1/endpoint/endpoint_name \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_endpoint.patchEndpoint": { + "id": "endpoint_endpoint.patchEndpoint", + "namespace": [ + "subpackage_endpoint" + ], + "description": "Updates an endpoint", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/v1/endpoint/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint to retrieve" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EndpointUpdate" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EndpointResponse" + } + } + }, + "examples": [ + { + "path": "/v1/endpoint/endpoint_name", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "name": "name", + "port": 1, + "replicas": [ + { + "account_key": "account_key", + "endpoint_name": "endpoint_name", + "replica_id": "replica_id", + "status": "pending", + "restarts": 1, + "age": 1 + } + ], + "auto_volume_experimental": true, + "concurrency_per_replica": 1, + "container_secrets": [ + "container_secrets" + ], + "description": "description", + "display_name": "display_name", + "endpoint": "endpoint", + "endpoint_state": "active", + "env_overrides": { + "env_overrides": { + "key": "value" + } + }, + "health_check_path": "health_check_path", + "image_url": "image_url", + "instance_type": "instance_type", + "max_replicas": 1, + "min_replicas": 1, + "registry_credential": "registry_credential", + "scale_to_zero": 1, + "visibility": "private", + "volumes_experimental": [ + { + "name": "name", + "path": "path", + "mount": "mount" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.octoai.cloud/v1/endpoint/endpoint_name \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_endpoint.getEndpoints": { + "id": "endpoint_endpoint.getEndpoints", + "namespace": [ + "subpackage_endpoint" + ], + "description": "Return list of endpoints", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/endpoints" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EndpointResponse" + } + } + } + }, + "examples": [ + { + "path": "/v1/endpoints", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "name": "name", + "port": 1, + "replicas": [ + { + "account_key": "account_key", + "endpoint_name": "endpoint_name", + "replica_id": "replica_id", + "status": "pending", + "restarts": 1, + "age": 1 + } + ], + "auto_volume_experimental": true, + "concurrency_per_replica": 1, + "container_secrets": [ + "container_secrets" + ], + "description": "description", + "display_name": "display_name", + "endpoint": "endpoint", + "endpoint_state": "active", + "env_overrides": { + "env_overrides": { + "key": "value" + } + }, + "health_check_path": "health_check_path", + "image_url": "image_url", + "instance_type": "instance_type", + "max_replicas": 1, + "min_replicas": 1, + "registry_credential": "registry_credential", + "scale_to_zero": 1, + "visibility": "private", + "volumes_experimental": [ + { + "name": "name", + "path": "path", + "mount": "mount" + } + ] + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/endpoints \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_endpoint.getContainerMetadata": { + "id": "endpoint_endpoint.getContainerMetadata", + "namespace": [ + "subpackage_endpoint" + ], + "description": "Return container metadata", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/endpoint/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + }, + { + "type": "literal", + "value": "/container/metadata" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint name" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ContainerResponse" + } + } + }, + "examples": [ + { + "path": "/v1/endpoint/endpoint_name/container/metadata", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "image_url": "image_url", + "exposed_ports": [ + { + "port_num": 1, + "proto": "proto" + } + ], + "labels": { + "labels": "labels" + }, + "env": [ + "env" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/endpoint/endpoint_name/container/metadata \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_endpoint.getEndpointVolumeToken": { + "id": "endpoint_endpoint.getEndpointVolumeToken", + "namespace": [ + "subpackage_endpoint" + ], + "description": "Returns a token for accessing the volume", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/endpoint/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + }, + { + "type": "literal", + "value": "/volume_token" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint name" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VolumeToken" + } + } + }, + "examples": [ + { + "path": "/v1/endpoint/endpoint_name/volume_token", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "token": "token" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/endpoint/endpoint_name/volume_token \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_telemetry.getEndpointLogs": { + "id": "endpoint_telemetry.getEndpointLogs", + "namespace": [ + "subpackage_telemetry" + ], + "description": "Return endpoint logs", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/logs/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint name" + } + ], + "queryParameters": [ + { + "key": "begin_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Optional begin of time range" + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Optional end of time range" + }, + { + "key": "max_lines", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of lines to return" + }, + { + "key": "replica_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Replica for which to fetch log output" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogEntry" + } + } + } + }, + "examples": [ + { + "path": "/v1/logs/endpoint_name", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "timestamp": "2024-01-15T09:30:00Z", + "replica_id": "replica_id", + "data": "data" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/logs/endpoint_name \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_telemetry.getEndpointLogsStream": { + "id": "endpoint_telemetry.getEndpointLogsStream", + "namespace": [ + "subpackage_telemetry" + ], + "description": "Return endpoint logs as stream", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/logs/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + }, + { + "type": "literal", + "value": "/stream" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint name" + } + ], + "queryParameters": [ + { + "key": "replica_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Replica for which to fetch log output" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LogEntry" + } + } + } + }, + "examples": [ + { + "path": "/v1/logs/endpoint_name/stream", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "timestamp": "2024-01-15T09:30:00Z", + "replica_id": "replica_id", + "data": "data" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/logs/endpoint_name/stream \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_telemetry.getEndpointEvents": { + "id": "endpoint_telemetry.getEndpointEvents", + "namespace": [ + "subpackage_telemetry" + ], + "description": "Return endpoint events", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/events/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint name" + } + ], + "queryParameters": [ + { + "key": "begin_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Optional begin of time range" + }, + { + "key": "end_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Optional end of time range" + }, + { + "key": "max_lines", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of lines to return" + }, + { + "key": "replica_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Replica for which to fetch log output" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EventEntry" + } + } + } + }, + "examples": [ + { + "path": "/v1/events/endpoint_name", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "timestamp": "2024-01-15T09:30:00Z", + "event": { + "type": "type", + "level": "normal", + "endpoint": "endpoint", + "tenant_id": "tenant_id", + "account_key": "account_key", + "instance_type": "instance_type" + }, + "replica_id": "replica_id" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/events/endpoint_name \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_telemetry.getEndpointEventsStream": { + "id": "endpoint_telemetry.getEndpointEventsStream", + "namespace": [ + "subpackage_telemetry" + ], + "description": "Return endpoint events as stream", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/events/" + }, + { + "type": "pathParameter", + "value": "endpoint_name" + }, + { + "type": "literal", + "value": "/stream" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The endpoint name" + } + ], + "queryParameters": [ + { + "key": "replica_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Replica for which to fetch log output" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:EventEntry" + } + } + } + }, + "examples": [ + { + "path": "/v1/events/endpoint_name/stream", + "responseStatusCode": 200, + "pathParameters": { + "endpoint_name": "endpoint_name" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "timestamp": "2024-01-15T09:30:00Z", + "event": { + "type": "type", + "level": "normal", + "endpoint": "endpoint", + "tenant_id": "tenant_id", + "account_key": "account_key", + "instance_type": "instance_type" + }, + "replica_id": "replica_id" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/events/endpoint_name/stream \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_secret.createSecret": { + "id": "endpoint_secret.createSecret", + "namespace": [ + "subpackage_secret" + ], + "description": "Create new secret", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/secret" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SecretKeyValue" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SecretKeyValue" + } + } + }, + "examples": [ + { + "path": "/v1/secret", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "key": "key", + "value": "value" + } + }, + "responseBody": { + "type": "json", + "value": { + "key": "key", + "value": "value" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/secret \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"key\": \"key\",\n \"value\": \"value\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_secret.getSecret": { + "id": "endpoint_secret.getSecret", + "namespace": [ + "subpackage_secret" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/secret/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of the secret to retrieve" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SecretKeyValue" + } + } + }, + "examples": [ + { + "path": "/v1/secret/key", + "responseStatusCode": 200, + "pathParameters": { + "key": "key" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "key": "key", + "value": "value" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/secret/key \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_secret.updateSecret": { + "id": "endpoint_secret.updateSecret", + "namespace": [ + "subpackage_secret" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/v1/secret/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of the secret to create or update" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SecretKeyValue" + } + } + }, + "examples": [ + { + "path": "/v1/secret/key", + "responseStatusCode": 200, + "pathParameters": { + "key": "key" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "value": "value" + } + }, + "responseBody": { + "type": "json", + "value": { + "key": "key", + "value": "value" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.octoai.cloud/v1/secret/key \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"value\": \"value\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_secret.deleteSecret": { + "id": "endpoint_secret.deleteSecret", + "namespace": [ + "subpackage_secret" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v1/secret/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of the secret to delete" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_secret:SecretDeleteSecretResponse" + } + } + }, + "examples": [ + { + "path": "/v1/secret/key", + "responseStatusCode": 200, + "pathParameters": { + "key": "key" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "message" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.octoai.cloud/v1/secret/key \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_secret.getSecrets": { + "id": "endpoint_secret.getSecrets", + "namespace": [ + "subpackage_secret" + ], + "description": "Return list of secrets", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/secrets" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "examples": [ + { + "path": "/v1/secrets", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + "string" + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/secrets \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_registryCredential.createRegistryCredential": { + "id": "endpoint_registryCredential.createRegistryCredential", + "namespace": [ + "subpackage_registryCredential" + ], + "description": "Create new registry credentials", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/registry-credential" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RegistryCredential" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RegistryCredentialSummary" + } + } + }, + "examples": [ + { + "path": "/v1/registry-credential", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "key": "key", + "username": "username", + "password": "password" + } + }, + "responseBody": { + "type": "json", + "value": { + "key": "key", + "username": "username" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/registry-credential \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"key\": \"key\",\n \"username\": \"username\",\n \"password\": \"password\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_registryCredential.getRegistryCredential": { + "id": "endpoint_registryCredential.getRegistryCredential", + "namespace": [ + "subpackage_registryCredential" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/registry-credential/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of the registry credential to retrieve" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RegistryCredential" + } + } + }, + "examples": [ + { + "path": "/v1/registry-credential/key", + "responseStatusCode": 200, + "pathParameters": { + "key": "key" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "key": "key", + "username": "username", + "password": "password" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/registry-credential/key \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_registryCredential.updateRegistryCredential": { + "id": "endpoint_registryCredential.updateRegistryCredential", + "namespace": [ + "subpackage_registryCredential" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/v1/registry-credential/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of the registry credential to create or update" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "username", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "password", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RegistryCredentialSummary" + } + } + }, + "examples": [ + { + "path": "/v1/registry-credential/key", + "responseStatusCode": 200, + "pathParameters": { + "key": "key" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "key": "key", + "username": "username" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.octoai.cloud/v1/registry-credential/key \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_registryCredential.deleteRegistryCredential": { + "id": "endpoint_registryCredential.deleteRegistryCredential", + "namespace": [ + "subpackage_registryCredential" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v1/registry-credential/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "pathParameters": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of the registry credential to delete" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_registryCredential:RegistryCredentialDeleteRegistryCredentialResponse" + } + } + }, + "examples": [ + { + "path": "/v1/registry-credential/key", + "responseStatusCode": 200, + "pathParameters": { + "key": "key" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "message": "message" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.octoai.cloud/v1/registry-credential/key \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_registryCredential.getRegistryCredentials": { + "id": "endpoint_registryCredential.getRegistryCredentials", + "namespace": [ + "subpackage_registryCredential" + ], + "description": "Return list of registry credentials", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/registry-credentials" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RegistryCredentialSummary" + } + } + } + }, + "examples": [ + { + "path": "/v1/registry-credentials", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "key": "key", + "username": "username" + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/registry-credentials \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_publicEndpoint.getPublicEndpoints": { + "id": "endpoint_publicEndpoint.getPublicEndpoints", + "namespace": [ + "subpackage_publicEndpoint" + ], + "description": "Return list of public, OctoAI-deployed endpoints", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/public-endpoints" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:HostedEndpoint" + } + } + } + }, + "examples": [ + { + "path": "/v1/public-endpoints", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "endpoint": "endpoint", + "name": "name", + "port": 1, + "auto_volume_experimental": true, + "concurrency_per_replica": 1, + "container_secrets": [ + "container_secrets" + ], + "description": "description", + "display_name": "display_name", + "endpoint_state": "active", + "env_overrides": { + "env_overrides": { + "key": "value" + } + }, + "health_check_path": "health_check_path", + "image_url": "image_url", + "instance_type": "instance_type", + "is_live": true, + "max_replicas": 1, + "min_replicas": 1, + "registry_credential": "registry_credential", + "scale_to_zero": 1, + "visibility": "private", + "volumes_experimental": [ + { + "name": "name", + "path": "path", + "mount": "mount" + } + ] + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/public-endpoints \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_instanceTypes.getInstanceTypes": { + "id": "endpoint_instanceTypes.getInstanceTypes", + "namespace": [ + "subpackage_instanceTypes" + ], + "description": "Return list of available instance types to deploy an endpoint to", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/instance-types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.octoai.cloud" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:InstanceTypeInfo" + } + } + } + }, + "examples": [ + { + "path": "/v1/instance-types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "instance_name": "instance_name", + "display_name": "display_name", + "vcpu": 1, + "ram": 1, + "vram": 1, + "accelerator": "none", + "available": true, + "price": 1.1 + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/instance-types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_endpoint:EndpointDeleteEndpointResponse": { + "name": "EndpointDeleteEndpointResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_secret:SecretDeleteSecretResponse": { + "name": "SecretDeleteSecretResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_registryCredential:RegistryCredentialDeleteRegistryCredentialResponse": { + "name": "RegistryCredentialDeleteRegistryCredentialResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:AccountStatus": { + "name": "AccountStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "ready_trial" + }, + { + "value": "ready_billed" + }, + { + "value": "suspended_billing" + }, + { + "value": "suspended_tos" + }, + { + "value": "error" + } + ] + } + }, + "type_:Account": { + "name": "Account", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "email", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "provider", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "country", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "company", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:AccountStatus" + } + } + ] + } + }, + "type_:EndpointUpdateVisibility": { + "name": "EndpointUpdateVisibility", + "description": "Visibility of the endpoint", + "shape": { + "type": "enum", + "values": [ + { + "value": "private" + }, + { + "value": "public" + } + ] + } + }, + "type_:EndpointUpdateEndpointState": { + "name": "EndpointUpdateEndpointState", + "description": "State of a endpoint", + "shape": { + "type": "enum", + "values": [ + { + "value": "active" + }, + { + "value": "disabled" + } + ] + } + }, + "type_:EndpointUpdate": { + "name": "EndpointUpdate", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "min_replicas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 999 + } + } + }, + "description": "Minimum number of replicas" + }, + { + "key": "max_replicas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 999 + } + } + }, + "description": "Maximum number of replicas" + }, + { + "key": "scale_to_zero", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 3600 + } + } + }, + "description": "Time to scale to zero (in seconds)" + }, + { + "key": "display_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "" + } + } + }, + "description": "User-friendly name of the endpoint (e.g. Stable Diffusion 2.1)" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "" + } + } + }, + "description": "Description of the endpoint" + }, + { + "key": "image_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL of the docker image" + }, + { + "key": "registry_credential", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The key of a registry credential used to authenticate to a private registry" + }, + { + "key": "health_check_path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL path of a health check endpoint" + }, + { + "key": "visibility", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EndpointUpdateVisibility" + } + }, + "description": "Visibility of the endpoint" + }, + { + "key": "endpoint_state", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EndpointUpdateEndpointState" + } + }, + "description": "State of a endpoint" + }, + { + "key": "env_overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "JSON object with environment variable overrides" + }, + { + "key": "instance_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Endpoint to query against" + }, + { + "key": "container_secrets", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of container secrets to inject as environment variables" + }, + { + "key": "concurrency_per_replica", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "maximum": 500 + } + } + }, + "description": "The maximum concurrency per replica" + } + ] + } + }, + "type_:EndpointCreate": { + "name": "EndpointCreate", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the endpoint" + }, + { + "key": "display_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "" + } + } + }, + "description": "User-friendly name of the endpoint (e.g. Stable Diffusion 2.1)" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "" + } + } + }, + "description": "Description of the endpoint" + }, + { + "key": "port", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Port number of the endpoint" + }, + { + "key": "health_check_path", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL path of a health check endpoint" + }, + { + "key": "auto_volume_experimental", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "EXPERIMENTAL: autogenerate a volume for the endpoint" + }, + { + "key": "volumes_experimental", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VolumeExperimental" + } + } + }, + "description": "EXPERIMENTAL: volumes to be used by this container" + }, + { + "key": "min_replicas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 999 + } + } + }, + "description": "Minimum number of replicas" + }, + { + "key": "max_replicas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 999 + } + } + }, + "description": "Maximum number of replicas" + }, + { + "key": "scale_to_zero", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 3600 + } + } + }, + "description": "Time to scale to zero (in seconds)" + }, + { + "key": "image_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL of the docker image" + }, + { + "key": "registry_credential", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The key of a registry credential used to authenticate to a private registry" + }, + { + "key": "visibility", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EndpointUpdateVisibility" + } + }, + "description": "Visibility of the endpoint" + }, + { + "key": "endpoint_state", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EndpointUpdateEndpointState" + } + }, + "description": "State of a endpoint" + }, + { + "key": "env_overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "JSON object with environment variable overrides" + }, + { + "key": "instance_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Endpoint to query against" + }, + { + "key": "container_secrets", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "A list of container secrets to inject as environment variables" + }, + { + "key": "concurrency_per_replica", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "maximum": 500 + } + } + }, + "description": "The maximum concurrency per replica" + } + ] + } + }, + "type_:VolumeExperimental": { + "name": "VolumeExperimental", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "path", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mount", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ContainerPort": { + "name": "ContainerPort", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "port_num", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + } + }, + { + "key": "proto", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ContainerResponse": { + "name": "ContainerResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "image_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "URL of the docker image" + }, + { + "key": "exposed_ports", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ContainerPort" + } + }, + "description": "Ports exposed by container" + }, + { + "key": "labels", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Labels for container" + }, + { + "key": "env", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Env is a list of environment variables to be used in a container" + } + ] + } + }, + "type_:VolumeToken": { + "name": "VolumeToken", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Opaque token for accessing the volume using OctoAI tooling (e.g. CLI)" + } + ] + } + }, + "type_:SecretKeyValue": { + "name": "SecretKeyValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Secret key" + }, + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Secret value" + } + ] + } + }, + "type_:RegistryCredential": { + "name": "RegistryCredential", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The lookup key for this credential" + }, + { + "key": "username", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Username corresponding to this credential" + }, + { + "key": "password", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The password for the credential" + } + ] + } + }, + "type_:RegistryCredentialSummary": { + "name": "RegistryCredentialSummary", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The lookup key for this credntial" + }, + { + "key": "username", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Username corresponding to this credential" + } + ] + } + }, + "type_:AggregationEnum": { + "name": "AggregationEnum", + "shape": { + "type": "enum", + "values": [ + { + "value": "1m" + }, + { + "value": "30m" + }, + { + "value": "1h" + }, + { + "value": "24h" + } + ] + } + }, + "type_:MetricEntry": { + "name": "MetricEntry", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "count_2xx", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + }, + "description": "the number of 2xx response codes" + }, + { + "key": "count_3xx", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + }, + "description": "the number of 3xx response codes" + }, + { + "key": "count_4xx", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + }, + "description": "the number of 4xx response codes" + }, + { + "key": "count_5xx", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + }, + "description": "the number of 5xx response codes" + }, + { + "key": "p99_millis", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + }, + "description": "the quantile for p99 response times in milliseconds" + }, + { + "key": "p95_millis", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + }, + "description": "the quantile for p95 response times in milliseconds" + }, + { + "key": "p50_millis", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + }, + "description": "the quantile for p50 response times in milliseconds" + } + ] + } + }, + "type_:EventEntry": { + "name": "EventEntry", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "time of the log entry (ISO8601 format)" + }, + { + "key": "replica_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "optional replica id associated with the event" + }, + { + "key": "event", + "valueShape": { + "type": "id", + "id": "type_:Event" + }, + "description": "event log data" + } + ] + } + }, + "type_:EventLevel": { + "name": "EventLevel", + "description": "type of event", + "shape": { + "type": "enum", + "values": [ + { + "value": "normal" + }, + { + "value": "warning" + } + ] + } + }, + "type_:Event": { + "name": "Event", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "level", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:EventLevel" + } + }, + "description": "type of event" + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "type of the event" + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "name of the endpoint" + }, + { + "key": "tenant_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the tenant" + }, + { + "key": "account_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Key of the account" + }, + { + "key": "instance_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "type of instance this event occurred on" + }, + { + "key": "details", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "extra details about this event" + } + ] + } + }, + "type_:LogEntry": { + "name": "LogEntry", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "timestamp", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "time of the log entry (ISO8601 format)" + }, + { + "key": "replica_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "unique ID of the replica" + }, + { + "key": "data", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "user-provided log data" + } + ] + } + }, + "type_:ReplicaStatus": { + "name": "ReplicaStatus", + "description": "status of the replica", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "running" + }, + { + "value": "succeeded" + }, + { + "value": "failed" + }, + { + "value": "unknown" + } + ] + } + }, + "type_:Replica": { + "name": "Replica", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "account_key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "account key for this replica" + }, + { + "key": "endpoint_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "endpoint name" + }, + { + "key": "replica_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "unique ID of the replica" + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:ReplicaStatus" + }, + "description": "status of the replica" + }, + { + "key": "restarts", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0 + } + } + }, + { + "key": "age", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "number of seconds this replica has been ready. set to -1 if replica is not ready" + } + ] + } + }, + "type_:EndpointResponse": { + "name": "EndpointResponse", + "shape": { + "type": "object", + "extends": [ + "type_:EndpointCreate" + ], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Endpoint to query against" + }, + { + "key": "replicas", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Replica" + } + }, + "description": "Active replicas for the endpoint" + } + ] + } + }, + "type_:HostedEndpoint": { + "name": "HostedEndpoint", + "shape": { + "type": "object", + "extends": [ + "type_:EndpointCreate" + ], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Endpoint to query against" + }, + { + "key": "is_live", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "If this endpoint should be considered live or not" + } + ] + } + }, + "type_:InstanceTypeInfoAccelerator": { + "name": "InstanceTypeInfoAccelerator", + "description": "Type of accelerator attached to this instance type", + "shape": { + "type": "enum", + "values": [ + { + "value": "none" + }, + { + "value": "gpu" + } + ] + } + }, + "type_:InstanceTypeInfo": { + "name": "InstanceTypeInfo", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "instance_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "String to specify when creating/updating an endpoint" + }, + { + "key": "display_name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "User-friendly name of the instance type" + }, + { + "key": "vcpu", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of vCPUs available on the instance type" + }, + { + "key": "ram", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Amount of memory in GB available on the instance type" + }, + { + "key": "vram", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Amount of video memory in GB available on the instance type" + }, + { + "key": "accelerator", + "valueShape": { + "type": "id", + "id": "type_:InstanceTypeInfoAccelerator" + }, + "description": "Type of accelerator attached to this instance type" + }, + { + "key": "available", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "If the hardware target is available right now" + }, + { + "key": "price", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Price per second in dollars (e.g. 0.0001 for 1/100th of a cent) to use this instance type" + } + ] + } + } + }, + "subpackages": { + "subpackage_account": { + "id": "subpackage_account", + "name": "account", + "displayName": "Account" + }, + "subpackage_endpoint": { + "id": "subpackage_endpoint", + "name": "endpoint", + "displayName": "Endpoint" + }, + "subpackage_telemetry": { + "id": "subpackage_telemetry", + "name": "telemetry" + }, + "subpackage_secret": { + "id": "subpackage_secret", + "name": "secret", + "displayName": "Secret" + }, + "subpackage_registryCredential": { + "id": "subpackage_registryCredential", + "name": "registryCredential" + }, + "subpackage_publicEndpoint": { + "id": "subpackage_publicEndpoint", + "name": "publicEndpoint" + }, + "subpackage_instanceTypes": { + "id": "subpackage_instanceTypes", + "name": "instanceTypes" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "token" + } + } + }, + { + "id": "2eeac53f-90cc-492b-9d29-e3ed711d7704", + "endpoints": { + "endpoint_.upscale": { + "id": "endpoint_.upscale", + "namespace": [], + "description": "Upscale the given image.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/upscaling" + } + ], + "environments": [], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "face_enhance", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "True to enable the face enhancer model variant" + }, + { + "key": "init_image_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "init_image", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UpscalingModel" + } + }, + "description": "One of UpscalingModel, identifies the upscaling model to use." + }, + { + "key": "output_image_height", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "output_image_width", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "output_image_encoding", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageEncoding" + } + }, + "description": "Define which encoding process should be applied before returning the modified image." + }, + { + "key": "scale", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ImageResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/upscaling", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "removed_for_safety": true, + "image_b64": "image_b64" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST /upscaling \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/upscaling", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST /upscaling \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_.remove_background": { + "id": "endpoint_.remove_background", + "namespace": [], + "description": "Remove background from the given image.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/background-removal" + } + ], + "environments": [], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "init_image", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "init_image_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "output_image_encoding", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "alpha_matting", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "alpha_matting_foreground_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 255 + } + } + } + }, + { + "key": "alpha_matting_background_threshold", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 255 + } + } + } + }, + { + "key": "alpha_matting_erode_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 255 + } + } + } + }, + { + "key": "only_mask", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "post_process_mask", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "bgcolor", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ImageResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/background-removal", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "removed_for_safety": true, + "image_b64": "image_b64" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST /background-removal \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/background-removal", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST /background-removal \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_.generate_images": { + "id": "endpoint_.generate_images", + "namespace": [], + "description": "Detail the given image.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/adetailer" + } + ], + "environments": [], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "init_image", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "init_image_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "image_encoding", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageEncoding" + } + }, + "description": "Define which encoding process should be applied before returning the modified image." + }, + { + "key": "transfer_images", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "negative_prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sampler", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Scheduler" + } + } + }, + { + "key": "steps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 20 + } + } + } + }, + { + "key": "inpainting_base_model", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ADetailerInpaintingBaseModel" + } + } + }, + { + "key": "checkpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "loras", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + } + }, + { + "key": "use_refiner", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "style_preset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "base" + } + } + } + }, + { + "key": "strength", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 1, + "default": 0.9 + } + } + } + }, + { + "key": "cfg_scale", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 50, + "default": 7.5 + } + } + }, + "description": "Floating-point number represeting how closely to adhere to prompt description. Must be a positive number no greater than 50.0." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ADetailerRequestSeed" + } + }, + "description": "Integer number or list of integers representing the seeds of random generators. Fixing random seed is useful when attempting to generate a specific image. Must be greater than 0 and less than 2^32." + }, + { + "key": "mask_dilation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "default": 4 + } + } + }, + "description": "A mask is created for each inpainted area in the image. Mask Dilation allows you to expand the size of the mask while maintaining its shape. This technique is typically used to reduce artifacts near borders in the mask. This parameter is the size, in pixels, of the dilation kernel to apply. Defaults to 4. Must be greater than or equal to 0 and recommended to be less than 64." + }, + { + "key": "mask_blur", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "default": 4 + } + } + }, + "description": "A mask is created for each inpainted area in the image. After dilation (see mask_dilation parameter), the mask is blurred. This technique is typically used to smoothly blend the inpainted area with the original image. This option specifies the radius, in pixels, of the gaussian blur kernel. The higher the value, the wider the blur. Defaults to 4. Must be greater than or equal to 0 and recommended to be less than 64." + }, + { + "key": "mask_padding", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "default": 32 + } + } + }, + "description": "Each inpainted area is passed to the image-to-image generator with some surrounding context. The contextual area is created by padding the area occupied by the blurred, dilated mask. This technique improves inpainting quality, and the contextual area is not modified. This parameter specifies the amount of padding, in pixels, to apply around the processed mask. When the computed padding goes off the edge of the image, the padded area is slid towards the center of the image. Must be greater than or equal to 0 and recommended to be less than 10% the size of an inpainting mask." + }, + { + "key": "max_num_detections", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 0.3 + } + } + }, + "description": "Inpainted areas are determined using a detector. This setting adjusts the sensitivity of the detector (lower considers more image fragments for inpainting). " + }, + { + "key": "detector", + "valueShape": { + "type": "id", + "id": "type_:ADetailerDetector" + }, + "description": "Detection model to use. Configures whether e.g. faces or hands or people are targeted for after-detailing." + }, + { + "key": "union_masks", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "When true, create a single mask by unioning the mask for each detected object together, then send a single inpainting request to the backing model." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ADetailerResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/adetailer", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "detector": "face_yolov8n" + } + }, + "responseBody": { + "type": "json", + "value": { + "num_objects_inpainted": 1, + "num_objects_detected": 1, + "num_removed_for_safety": 1, + "image_b64": "image_b64" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST /adetailer \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"detector\": \"face_yolov8n\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/adetailer", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "detector": "face_yolov8n" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST /adetailer \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"detector\": \"face_yolov8n\"\n}'", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:ADetailerRequestSeed": { + "name": "ADetailerRequestSeed", + "description": "Integer number or list of integers representing the seeds of random generators. Fixing random seed is useful when attempting to generate a specific image. Must be greater than 0 and less than 2^32.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + ] + } + }, + "type_:ADetailerDetector": { + "name": "ADetailerDetector", + "description": "ADetailer detector models available.", + "shape": { + "type": "enum", + "values": [ + { + "value": "face_yolov8n" + }, + { + "value": "hand_yolov8n" + }, + { + "value": "face_full_mediapipe" + }, + { + "value": "face_short_mediapipe" + }, + { + "value": "face_mesh_mediapipe" + }, + { + "value": "eyes_mesh_mediapipe" + }, + { + "value": "face_hair_mediapipe" + } + ] + } + }, + "type_:ADetailerInpaintingBaseModel": { + "name": "ADetailerInpaintingBaseModel", + "description": "Base model which ADetailer should use for inpainting.", + "shape": { + "type": "enum", + "values": [ + { + "value": "sdxl" + }, + { + "value": "sd15" + } + ] + } + }, + "type_:ADetailerResponse": { + "name": "ADetailerResponse", + "description": "Represent an adetailed image.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "image_b64", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "num_objects_inpainted", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of objects that were successfully inpainted." + }, + { + "key": "num_objects_detected", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of objects that were successfully detected." + }, + { + "key": "num_removed_for_safety", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of inpainting requests that violated the OctoAI Terms of Service." + } + ] + } + }, + "type_:HTTPValidationError": { + "name": "HTTPValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ValidationError" + } + } + } + } + ] + } + }, + "type_:ImageEncoding": { + "name": "ImageEncoding", + "description": "The image encoding types available for image modification response.", + "shape": { + "type": "enum", + "values": [ + { + "value": "jpeg" + }, + { + "value": "png" + } + ] + } + }, + "type_:ImageResponse": { + "name": "ImageResponse", + "description": "Represent a generated image.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "image_b64", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "removed_for_safety", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if the image was removed for safety, False otherwise." + } + ] + } + }, + "type_:Scheduler": { + "name": "Scheduler", + "description": "The schedulers available for image generation.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PNDM" + }, + { + "value": "LMS" + }, + { + "value": "KLMS" + }, + { + "value": "DDIM" + }, + { + "value": "DDPM" + }, + { + "value": "HEUN" + }, + { + "value": "K_HEUN" + }, + { + "value": "K_EULER" + }, + { + "value": "K_EULER_ANCESTRAL" + }, + { + "value": "DPM_SOLVER_MULTISTEP" + }, + { + "value": "DPM_PLUS_PLUS_2M_KARRAS" + }, + { + "value": "DPM_SINGLE" + }, + { + "value": "DPM_2" + }, + { + "value": "DPM_2_ANCESTRAL" + }, + { + "value": "DPM_PLUS_PLUS_SDE_KARRAS" + }, + { + "value": "UNI_PC" + }, + { + "value": "LCM" + } + ] + } + }, + "type_:UpscalingModel": { + "name": "UpscalingModel", + "description": "Specifies models either in the API or in server config.", + "shape": { + "type": "enum", + "values": [ + { + "value": "real-esrgan-x4-plus" + }, + { + "value": "real-esrgan-x4-v3" + }, + { + "value": "real-esrgan-x4-v3-wdn" + }, + { + "value": "real-esrgan-animevideo-v3" + }, + { + "value": "real-esrgan-x4-plus-anime" + }, + { + "value": "real-esrgan-x2-plus" + } + ] + } + }, + "type_:ValidationErrorLocItem": { + "name": "ValidationErrorLocItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_:ValidationError": { + "name": "ValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "loc", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ValidationErrorLocItem" + } + } + }, + { + "key": "msg", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "apiKey" + } + } + }, + { + "id": "270fcb14-fecb-45b5-8075-3e207a0d4b31", + "endpoints": { + "endpoint_asset-library.list": { + "id": "endpoint_asset-library.list", + "namespace": [ + "subpackage_asset-library" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/assets" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "queryParameters": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "is_public", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "data_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:DataType" + } + } + }, + { + "key": "asset_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:AssetType" + } + } + }, + { + "key": "engine", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:BaseEngine" + } + } + }, + { + "key": "engine_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:BaseEngineType" + } + } + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "get_preview_urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "asset_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "owner", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:ListAssetsResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/assets", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [], + "has_more": true, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/assets", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.list();\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/assets", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "name": "string", + "is_public": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.octoai.cloud/v1/assets \\\n -d name=string \\\n -d is_public=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.list();\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.assetLibrary.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "isPublic: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "is_public" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "fp16": "OctoAI.DataType.Fp16", + "fp32": "OctoAI.DataType.Fp32", + "int4": "OctoAI.DataType.Int4", + "int8": "OctoAI.DataType.Int8" + }, + "templateString": "dataType: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "data_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "file": "OctoAI.AssetType.File", + "checkpoint": "OctoAI.AssetType.Checkpoint", + "lora": "OctoAI.AssetType.Lora", + "textual_inversion": "OctoAI.AssetType.TextualInversion", + "vae": "OctoAI.AssetType.Vae", + "latent": "OctoAI.AssetType.Latent" + }, + "templateString": "assetType: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "asset_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text/llama-2-7b": "OctoAI.BaseEngine.TextLlama27B", + "text/llama-2-13b": "OctoAI.BaseEngine.TextLlama213B", + "text/llama-2-70b": "OctoAI.BaseEngine.TextLlama270B", + "text/codellama-7b": "OctoAI.BaseEngine.TextCodellama7B", + "text/codellama-13b": "OctoAI.BaseEngine.TextCodellama13B", + "text/codellama-34b": "OctoAI.BaseEngine.TextCodellama34B", + "text/codellama-70b": "OctoAI.BaseEngine.TextCodellama70B", + "text/mistral-7b": "OctoAI.BaseEngine.TextMistral7B", + "text/mixtral-8x7b": "OctoAI.BaseEngine.TextMixtral8X7B", + "image/controlnet-sd15": "OctoAI.BaseEngine.ImageControlnetSd15", + "image/controlnet-sdxl": "OctoAI.BaseEngine.ImageControlnetSdxl", + "image/stable-diffusion-v1-5": "OctoAI.BaseEngine.ImageStableDiffusionV15", + "image/stable-diffusion-xl-v1-0": "OctoAI.BaseEngine.ImageStableDiffusionXlV10", + "image/stable-diffusion-ssd": "OctoAI.BaseEngine.ImageStableDiffusionSsd", + "audio/tortoise-tts": "OctoAI.BaseEngine.AudioTortoiseTts", + "audio/rvc": "OctoAI.BaseEngine.AudioRvc" + }, + "templateString": "engine: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "engine" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text": "OctoAI.BaseEngineType.Text", + "image": "OctoAI.BaseEngineType.Image", + "audio": "OctoAI.BaseEngineType.Audio" + }, + "templateString": "engineType: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "engine_type" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "limit: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "limit" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "offset: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "offset" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "getPreviewUrls: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "get_preview_urls" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "assetIds: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "asset_ids" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "owner: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "owner" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.asset_library.list(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "name", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "is_public=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "is_public", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "data_type=$FERN_INPUT", + "values": { + "fp16": "\"fp16\"", + "fp32": "\"fp32\"", + "int4": "\"int4\"", + "int8": "\"int8\"" + }, + "templateInput": { + "location": "QUERY", + "path": "data_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "asset_type=$FERN_INPUT", + "values": { + "file": "\"file\"", + "checkpoint": "\"checkpoint\"", + "lora": "\"lora\"", + "textual_inversion": "\"textual_inversion\"", + "vae": "\"vae\"", + "latent": "\"latent\"" + }, + "templateInput": { + "location": "QUERY", + "path": "asset_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "values": { + "text/llama-2-7b": "\"text/llama-2-7b\"", + "text/llama-2-13b": "\"text/llama-2-13b\"", + "text/llama-2-70b": "\"text/llama-2-70b\"", + "text/codellama-7b": "\"text/codellama-7b\"", + "text/codellama-13b": "\"text/codellama-13b\"", + "text/codellama-34b": "\"text/codellama-34b\"", + "text/codellama-70b": "\"text/codellama-70b\"", + "text/mistral-7b": "\"text/mistral-7b\"", + "text/mixtral-8x7b": "\"text/mixtral-8x7b\"", + "image/controlnet-sd15": "\"image/controlnet-sd15\"", + "image/controlnet-sdxl": "\"image/controlnet-sdxl\"", + "image/stable-diffusion-v1-5": "\"image/stable-diffusion-v1-5\"", + "image/stable-diffusion-xl-v1-0": "\"image/stable-diffusion-xl-v1-0\"", + "image/stable-diffusion-ssd": "\"image/stable-diffusion-ssd\"", + "audio/tortoise-tts": "\"audio/tortoise-tts\"", + "audio/rvc": "\"audio/rvc\"" + }, + "templateInput": { + "location": "QUERY", + "path": "engine" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine_type=$FERN_INPUT", + "values": { + "text": "\"text\"", + "image": "\"image\"", + "audio": "\"audio\"" + }, + "templateInput": { + "location": "QUERY", + "path": "engine_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "limit=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "limit", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "offset=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "offset", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "get_preview_urls=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "get_preview_urls", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "asset_ids=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "asset_ids", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "owner=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "owner", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_asset-library.create": { + "id": "endpoint_asset-library.create", + "namespace": [ + "subpackage_asset-library" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/assets" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "asset_type", + "valueShape": { + "type": "id", + "id": "type_asset-library:AssetType" + }, + "description": "Asset type." + }, + { + "key": "data", + "valueShape": { + "type": "id", + "id": "type_asset-library:Data" + }, + "description": "Asset data." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "hf_repo", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "hf_token_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "is_public", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "True if asset is public." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset name." + }, + { + "key": "skip_validation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Skip asset validation." + }, + { + "key": "transfer_api_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:TransferApiType" + } + }, + "description": "Transfer API type." + }, + { + "key": "url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1 + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:CreateAssetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/assets", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "asset_type": "file", + "data": { + "asset_type": "checkpoint", + "engine": "text/llama-2-7b" + }, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "asset": { + "asset_type": "file", + "created_at": "string", + "data": { + "asset_type": "checkpoint", + "engine": "text/llama-2-7b", + "data_type": "fp16", + "file_format": "safetensors" + }, + "description": "string", + "id": "string", + "name": "string", + "size_bytes": 0, + "status": "ready_to_upload", + "status_details": "string", + "tenant_uuid": "string", + "file_structure": "unknown", + "hf_repo": "string", + "is_public": true, + "status_info": { + "string": {} + }, + "url": "string" + }, + "transfer_api": { + "type": "none" + }, + "token": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/assets \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"asset_type\": \"file\",\n \"data\": {\n \"asset_type\": \"checkpoint\",\n \"engine\": \"text/llama-2-7b\"\n },\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.asset_library import Data_Checkpoint\nfrom octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.create(\n asset_type=\"file\",\n data=Data_Checkpoint(\n data_type=\"fp16\",\n engine=\"text/llama-2-7b\",\n file_format=\"safetensors\",\n ),\n description=\"string\",\n hf_repo=\"string\",\n hf_token_secret=\"string\",\n is_public=True,\n name=\"string\",\n skip_validation=True,\n transfer_api_type=\"presigned-url\",\n url=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient, OctoAI } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.create({\n assetType: OctoAI.AssetType.File,\n data: {\n assetType: \"checkpoint\",\n dataType: OctoAI.DataType.Fp16,\n engine: OctoAI.BaseEngine.TextLlama27B,\n fileFormat: OctoAI.FileFormat.Safetensors\n },\n description: \"string\",\n hfRepo: \"string\",\n hfTokenSecret: \"string\",\n isPublic: true,\n name: \"string\",\n skipValidation: true,\n transferApiType: OctoAI.TransferApiType.PresignedUrl,\n url: \"string\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/assets", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "asset_type": "file", + "data": { + "asset_type": "checkpoint", + "engine": "text/llama-2-7b" + }, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/assets \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"asset_type\": \"file\",\n \"data\": {\n \"asset_type\": \"checkpoint\",\n \"engine\": \"text/llama-2-7b\"\n },\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.asset_library import Data_Checkpoint\nfrom octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.create(\n asset_type=\"file\",\n data=Data_Checkpoint(\n data_type=\"fp16\",\n engine=\"text/llama-2-7b\",\n file_format=\"safetensors\",\n ),\n description=\"string\",\n hf_repo=\"string\",\n hf_token_secret=\"string\",\n is_public=True,\n name=\"string\",\n skip_validation=True,\n transfer_api_type=\"presigned-url\",\n url=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient, OctoAI } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.create({\n assetType: OctoAI.AssetType.File,\n data: {\n assetType: \"checkpoint\",\n dataType: OctoAI.DataType.Fp16,\n engine: OctoAI.BaseEngine.TextLlama27B,\n fileFormat: OctoAI.FileFormat.Safetensors\n },\n description: \"string\",\n hfRepo: \"string\",\n hfTokenSecret: \"string\",\n isPublic: true,\n name: \"string\",\n skipValidation: true,\n transferApiType: OctoAI.TransferApiType.PresignedUrl,\n url: \"string\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.assetLibrary.create(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "file": "OctoAI.AssetType.File", + "checkpoint": "OctoAI.AssetType.Checkpoint", + "lora": "OctoAI.AssetType.Lora", + "textual_inversion": "OctoAI.AssetType.TextualInversion", + "vae": "OctoAI.AssetType.Vae", + "latent": "OctoAI.AssetType.Latent" + }, + "templateString": "assetType: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "asset_type" + } + } + }, + { + "type": "template", + "value": { + "type": "discriminatedUnion", + "imports": [], + "isOptional": true, + "templateString": "data: '$FERN_INPUT'", + "discriminantField": "asset_type", + "members": { + "checkpoint": { + "type": "generic", + "imports": [], + "templateString": "data: { \n\t\t\tassetType : \"checkpoint\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "fp16": "OctoAI.DataType.Fp16", + "fp32": "OctoAI.DataType.Fp32", + "int4": "OctoAI.DataType.Int4", + "int8": "OctoAI.DataType.Int8" + }, + "templateString": "dataType: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.data_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text/llama-2-7b": "OctoAI.BaseEngine.TextLlama27B", + "text/llama-2-13b": "OctoAI.BaseEngine.TextLlama213B", + "text/llama-2-70b": "OctoAI.BaseEngine.TextLlama270B", + "text/codellama-7b": "OctoAI.BaseEngine.TextCodellama7B", + "text/codellama-13b": "OctoAI.BaseEngine.TextCodellama13B", + "text/codellama-34b": "OctoAI.BaseEngine.TextCodellama34B", + "text/codellama-70b": "OctoAI.BaseEngine.TextCodellama70B", + "text/mistral-7b": "OctoAI.BaseEngine.TextMistral7B", + "text/mixtral-8x7b": "OctoAI.BaseEngine.TextMixtral8X7B", + "image/controlnet-sd15": "OctoAI.BaseEngine.ImageControlnetSd15", + "image/controlnet-sdxl": "OctoAI.BaseEngine.ImageControlnetSdxl", + "image/stable-diffusion-v1-5": "OctoAI.BaseEngine.ImageStableDiffusionV15", + "image/stable-diffusion-xl-v1-0": "OctoAI.BaseEngine.ImageStableDiffusionXlV10", + "image/stable-diffusion-ssd": "OctoAI.BaseEngine.ImageStableDiffusionSsd", + "audio/tortoise-tts": "OctoAI.BaseEngine.AudioTortoiseTts", + "audio/rvc": "OctoAI.BaseEngine.AudioRvc" + }, + "templateString": "engine: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.engine" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "safetensors": "OctoAI.FileFormat.Safetensors", + "pt": "OctoAI.FileFormat.Pt" + }, + "templateString": "fileFormat: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.file_format" + } + } + } + ] + } + } + ] + }, + "file": { + "type": "generic", + "imports": [], + "templateString": "data: { \n\t\t\tassetType : \"file\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "unknown": "OctoAI.FileExtension.Unknown", + "png": "OctoAI.FileExtension.Png", + "jpg": "OctoAI.FileExtension.Jpg", + "jpeg": "OctoAI.FileExtension.Jpeg", + "txt": "OctoAI.FileExtension.Txt", + "mp3": "OctoAI.FileExtension.Mp3", + "wav": "OctoAI.FileExtension.Wav" + }, + "templateString": "fileFormat: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.file_format" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "previewUrl: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "data.preview_url" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "version: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "data.version" + } + ] + } + } + ] + } + } + ] + }, + "latent": { + "type": "generic", + "imports": [], + "templateString": "data: { \n\t\t\tassetType : \"latent\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text/llama-2-7b": "OctoAI.BaseEngine.TextLlama27B", + "text/llama-2-13b": "OctoAI.BaseEngine.TextLlama213B", + "text/llama-2-70b": "OctoAI.BaseEngine.TextLlama270B", + "text/codellama-7b": "OctoAI.BaseEngine.TextCodellama7B", + "text/codellama-13b": "OctoAI.BaseEngine.TextCodellama13B", + "text/codellama-34b": "OctoAI.BaseEngine.TextCodellama34B", + "text/codellama-70b": "OctoAI.BaseEngine.TextCodellama70B", + "text/mistral-7b": "OctoAI.BaseEngine.TextMistral7B", + "text/mixtral-8x7b": "OctoAI.BaseEngine.TextMixtral8X7B", + "image/controlnet-sd15": "OctoAI.BaseEngine.ImageControlnetSd15", + "image/controlnet-sdxl": "OctoAI.BaseEngine.ImageControlnetSdxl", + "image/stable-diffusion-v1-5": "OctoAI.BaseEngine.ImageStableDiffusionV15", + "image/stable-diffusion-xl-v1-0": "OctoAI.BaseEngine.ImageStableDiffusionXlV10", + "image/stable-diffusion-ssd": "OctoAI.BaseEngine.ImageStableDiffusionSsd", + "audio/tortoise-tts": "OctoAI.BaseEngine.AudioTortoiseTts", + "audio/rvc": "OctoAI.BaseEngine.AudioRvc" + }, + "templateString": "engine: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.engine" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "safetensors": "OctoAI.FileFormat.Safetensors", + "pt": "OctoAI.FileFormat.Pt" + }, + "templateString": "fileFormat: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.file_format" + } + } + } + ] + } + } + ] + }, + "lora": { + "type": "generic", + "imports": [], + "templateString": "data: { \n\t\t\tassetType : \"lora\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "checkpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "data.checkpoint" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "fp16": "OctoAI.DataType.Fp16", + "fp32": "OctoAI.DataType.Fp32", + "int4": "OctoAI.DataType.Int4", + "int8": "OctoAI.DataType.Int8" + }, + "templateString": "dataType: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.data_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text/llama-2-7b": "OctoAI.BaseEngine.TextLlama27B", + "text/llama-2-13b": "OctoAI.BaseEngine.TextLlama213B", + "text/llama-2-70b": "OctoAI.BaseEngine.TextLlama270B", + "text/codellama-7b": "OctoAI.BaseEngine.TextCodellama7B", + "text/codellama-13b": "OctoAI.BaseEngine.TextCodellama13B", + "text/codellama-34b": "OctoAI.BaseEngine.TextCodellama34B", + "text/codellama-70b": "OctoAI.BaseEngine.TextCodellama70B", + "text/mistral-7b": "OctoAI.BaseEngine.TextMistral7B", + "text/mixtral-8x7b": "OctoAI.BaseEngine.TextMixtral8X7B", + "image/controlnet-sd15": "OctoAI.BaseEngine.ImageControlnetSd15", + "image/controlnet-sdxl": "OctoAI.BaseEngine.ImageControlnetSdxl", + "image/stable-diffusion-v1-5": "OctoAI.BaseEngine.ImageStableDiffusionV15", + "image/stable-diffusion-xl-v1-0": "OctoAI.BaseEngine.ImageStableDiffusionXlV10", + "image/stable-diffusion-ssd": "OctoAI.BaseEngine.ImageStableDiffusionSsd", + "audio/tortoise-tts": "OctoAI.BaseEngine.AudioTortoiseTts", + "audio/rvc": "OctoAI.BaseEngine.AudioRvc" + }, + "templateString": "engine: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.engine" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "safetensors": "OctoAI.FileFormat.Safetensors", + "pt": "OctoAI.FileFormat.Pt" + }, + "templateString": "fileFormat: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.file_format" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "triggerWords: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "data.trigger_words" + } + } + } + ] + } + } + ] + }, + "textual_inversion": { + "type": "generic", + "imports": [], + "templateString": "data: { \n\t\t\tassetType : \"textual_inversion\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "fp16": "OctoAI.DataType.Fp16", + "fp32": "OctoAI.DataType.Fp32", + "int4": "OctoAI.DataType.Int4", + "int8": "OctoAI.DataType.Int8" + }, + "templateString": "dataType: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.data_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text/llama-2-7b": "OctoAI.BaseEngine.TextLlama27B", + "text/llama-2-13b": "OctoAI.BaseEngine.TextLlama213B", + "text/llama-2-70b": "OctoAI.BaseEngine.TextLlama270B", + "text/codellama-7b": "OctoAI.BaseEngine.TextCodellama7B", + "text/codellama-13b": "OctoAI.BaseEngine.TextCodellama13B", + "text/codellama-34b": "OctoAI.BaseEngine.TextCodellama34B", + "text/codellama-70b": "OctoAI.BaseEngine.TextCodellama70B", + "text/mistral-7b": "OctoAI.BaseEngine.TextMistral7B", + "text/mixtral-8x7b": "OctoAI.BaseEngine.TextMixtral8X7B", + "image/controlnet-sd15": "OctoAI.BaseEngine.ImageControlnetSd15", + "image/controlnet-sdxl": "OctoAI.BaseEngine.ImageControlnetSdxl", + "image/stable-diffusion-v1-5": "OctoAI.BaseEngine.ImageStableDiffusionV15", + "image/stable-diffusion-xl-v1-0": "OctoAI.BaseEngine.ImageStableDiffusionXlV10", + "image/stable-diffusion-ssd": "OctoAI.BaseEngine.ImageStableDiffusionSsd", + "audio/tortoise-tts": "OctoAI.BaseEngine.AudioTortoiseTts", + "audio/rvc": "OctoAI.BaseEngine.AudioRvc" + }, + "templateString": "engine: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.engine" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "safetensors": "OctoAI.FileFormat.Safetensors", + "pt": "OctoAI.FileFormat.Pt" + }, + "templateString": "fileFormat: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.file_format" + } + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "triggerWords: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "data.trigger_words" + } + } + } + ] + } + } + ] + }, + "vae": { + "type": "generic", + "imports": [], + "templateString": "data: { \n\t\t\tassetType : \"vae\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "fp16": "OctoAI.DataType.Fp16", + "fp32": "OctoAI.DataType.Fp32", + "int4": "OctoAI.DataType.Int4", + "int8": "OctoAI.DataType.Int8" + }, + "templateString": "dataType: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.data_type" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text/llama-2-7b": "OctoAI.BaseEngine.TextLlama27B", + "text/llama-2-13b": "OctoAI.BaseEngine.TextLlama213B", + "text/llama-2-70b": "OctoAI.BaseEngine.TextLlama270B", + "text/codellama-7b": "OctoAI.BaseEngine.TextCodellama7B", + "text/codellama-13b": "OctoAI.BaseEngine.TextCodellama13B", + "text/codellama-34b": "OctoAI.BaseEngine.TextCodellama34B", + "text/codellama-70b": "OctoAI.BaseEngine.TextCodellama70B", + "text/mistral-7b": "OctoAI.BaseEngine.TextMistral7B", + "text/mixtral-8x7b": "OctoAI.BaseEngine.TextMixtral8X7B", + "image/controlnet-sd15": "OctoAI.BaseEngine.ImageControlnetSd15", + "image/controlnet-sdxl": "OctoAI.BaseEngine.ImageControlnetSdxl", + "image/stable-diffusion-v1-5": "OctoAI.BaseEngine.ImageStableDiffusionV15", + "image/stable-diffusion-xl-v1-0": "OctoAI.BaseEngine.ImageStableDiffusionXlV10", + "image/stable-diffusion-ssd": "OctoAI.BaseEngine.ImageStableDiffusionSsd", + "audio/tortoise-tts": "OctoAI.BaseEngine.AudioTortoiseTts", + "audio/rvc": "OctoAI.BaseEngine.AudioRvc" + }, + "templateString": "engine: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.engine" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "safetensors": "OctoAI.FileFormat.Safetensors", + "pt": "OctoAI.FileFormat.Pt" + }, + "templateString": "fileFormat: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "data.file_format" + } + } + } + ] + } + } + ] + } + }, + "templateInput": { + "location": "BODY", + "path": "data" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "hfRepo: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "hf_repo" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "hfTokenSecret: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "hf_token_secret" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "isPublic: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "is_public" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "skipValidation: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "skip_validation" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "presigned-url": "OctoAI.TransferApiType.PresignedUrl", + "sts": "OctoAI.TransferApiType.Sts" + }, + "templateString": "transferApiType: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "transfer_api_type" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "url: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "url" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.asset_library.create(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "asset_type=$FERN_INPUT", + "values": { + "file": "\"file\"", + "checkpoint": "\"checkpoint\"", + "lora": "\"lora\"", + "textual_inversion": "\"textual_inversion\"", + "vae": "\"vae\"", + "latent": "\"latent\"" + }, + "templateInput": { + "location": "BODY", + "path": "asset_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "data=$FERN_INPUT", + "discriminantField": "asset_type", + "members": { + "checkpoint": { + "imports": [ + "from octoai.asset_library import Data_Checkpoint" + ], + "isOptional": true, + "templateString": "data=Data_Checkpoint($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "data_type=$FERN_INPUT", + "values": { + "fp16": "\"fp16\"", + "fp32": "\"fp32\"", + "int4": "\"int4\"", + "int8": "\"int8\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.data_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "values": { + "text/llama-2-7b": "\"text/llama-2-7b\"", + "text/llama-2-13b": "\"text/llama-2-13b\"", + "text/llama-2-70b": "\"text/llama-2-70b\"", + "text/codellama-7b": "\"text/codellama-7b\"", + "text/codellama-13b": "\"text/codellama-13b\"", + "text/codellama-34b": "\"text/codellama-34b\"", + "text/codellama-70b": "\"text/codellama-70b\"", + "text/mistral-7b": "\"text/mistral-7b\"", + "text/mixtral-8x7b": "\"text/mixtral-8x7b\"", + "image/controlnet-sd15": "\"image/controlnet-sd15\"", + "image/controlnet-sdxl": "\"image/controlnet-sdxl\"", + "image/stable-diffusion-v1-5": "\"image/stable-diffusion-v1-5\"", + "image/stable-diffusion-xl-v1-0": "\"image/stable-diffusion-xl-v1-0\"", + "image/stable-diffusion-ssd": "\"image/stable-diffusion-ssd\"", + "audio/tortoise-tts": "\"audio/tortoise-tts\"", + "audio/rvc": "\"audio/rvc\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.engine" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "file_format=$FERN_INPUT", + "values": { + "safetensors": "\"safetensors\"", + "pt": "\"pt\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.file_format" + }, + "type": "enum" + } + } + ], + "type": "generic" + }, + "file": { + "imports": [ + "from octoai.asset_library import Data_File" + ], + "isOptional": true, + "templateString": "data=Data_File($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "file_format=$FERN_INPUT", + "values": { + "unknown": "\"unknown\"", + "png": "\"png\"", + "jpg": "\"jpg\"", + "jpeg": "\"jpeg\"", + "txt": "\"txt\"", + "mp3": "\"mp3\"", + "wav": "\"wav\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.file_format" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "preview_url=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "data.preview_url", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "version=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "data.version", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "type": "generic" + }, + "latent": { + "imports": [ + "from octoai.asset_library import Data_Latent" + ], + "isOptional": true, + "templateString": "data=Data_Latent($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "values": { + "text/llama-2-7b": "\"text/llama-2-7b\"", + "text/llama-2-13b": "\"text/llama-2-13b\"", + "text/llama-2-70b": "\"text/llama-2-70b\"", + "text/codellama-7b": "\"text/codellama-7b\"", + "text/codellama-13b": "\"text/codellama-13b\"", + "text/codellama-34b": "\"text/codellama-34b\"", + "text/codellama-70b": "\"text/codellama-70b\"", + "text/mistral-7b": "\"text/mistral-7b\"", + "text/mixtral-8x7b": "\"text/mixtral-8x7b\"", + "image/controlnet-sd15": "\"image/controlnet-sd15\"", + "image/controlnet-sdxl": "\"image/controlnet-sdxl\"", + "image/stable-diffusion-v1-5": "\"image/stable-diffusion-v1-5\"", + "image/stable-diffusion-xl-v1-0": "\"image/stable-diffusion-xl-v1-0\"", + "image/stable-diffusion-ssd": "\"image/stable-diffusion-ssd\"", + "audio/tortoise-tts": "\"audio/tortoise-tts\"", + "audio/rvc": "\"audio/rvc\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.engine" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "file_format=$FERN_INPUT", + "values": { + "safetensors": "\"safetensors\"", + "pt": "\"pt\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.file_format" + }, + "type": "enum" + } + } + ], + "type": "generic" + }, + "lora": { + "imports": [ + "from octoai.asset_library import Data_Lora" + ], + "isOptional": true, + "templateString": "data=Data_Lora($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "checkpoint=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "data.checkpoint", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "data_type=$FERN_INPUT", + "values": { + "fp16": "\"fp16\"", + "fp32": "\"fp32\"", + "int4": "\"int4\"", + "int8": "\"int8\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.data_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "values": { + "text/llama-2-7b": "\"text/llama-2-7b\"", + "text/llama-2-13b": "\"text/llama-2-13b\"", + "text/llama-2-70b": "\"text/llama-2-70b\"", + "text/codellama-7b": "\"text/codellama-7b\"", + "text/codellama-13b": "\"text/codellama-13b\"", + "text/codellama-34b": "\"text/codellama-34b\"", + "text/codellama-70b": "\"text/codellama-70b\"", + "text/mistral-7b": "\"text/mistral-7b\"", + "text/mixtral-8x7b": "\"text/mixtral-8x7b\"", + "image/controlnet-sd15": "\"image/controlnet-sd15\"", + "image/controlnet-sdxl": "\"image/controlnet-sdxl\"", + "image/stable-diffusion-v1-5": "\"image/stable-diffusion-v1-5\"", + "image/stable-diffusion-xl-v1-0": "\"image/stable-diffusion-xl-v1-0\"", + "image/stable-diffusion-ssd": "\"image/stable-diffusion-ssd\"", + "audio/tortoise-tts": "\"audio/tortoise-tts\"", + "audio/rvc": "\"audio/rvc\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.engine" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "file_format=$FERN_INPUT", + "values": { + "safetensors": "\"safetensors\"", + "pt": "\"pt\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.file_format" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "trigger_words=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "data.trigger_words" + }, + "type": "iterable" + } + } + ], + "type": "generic" + }, + "textual_inversion": { + "imports": [ + "from octoai.asset_library import Data_TextualInversion" + ], + "isOptional": true, + "templateString": "data=Data_TextualInversion($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "data_type=$FERN_INPUT", + "values": { + "fp16": "\"fp16\"", + "fp32": "\"fp32\"", + "int4": "\"int4\"", + "int8": "\"int8\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.data_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "values": { + "text/llama-2-7b": "\"text/llama-2-7b\"", + "text/llama-2-13b": "\"text/llama-2-13b\"", + "text/llama-2-70b": "\"text/llama-2-70b\"", + "text/codellama-7b": "\"text/codellama-7b\"", + "text/codellama-13b": "\"text/codellama-13b\"", + "text/codellama-34b": "\"text/codellama-34b\"", + "text/codellama-70b": "\"text/codellama-70b\"", + "text/mistral-7b": "\"text/mistral-7b\"", + "text/mixtral-8x7b": "\"text/mixtral-8x7b\"", + "image/controlnet-sd15": "\"image/controlnet-sd15\"", + "image/controlnet-sdxl": "\"image/controlnet-sdxl\"", + "image/stable-diffusion-v1-5": "\"image/stable-diffusion-v1-5\"", + "image/stable-diffusion-xl-v1-0": "\"image/stable-diffusion-xl-v1-0\"", + "image/stable-diffusion-ssd": "\"image/stable-diffusion-ssd\"", + "audio/tortoise-tts": "\"audio/tortoise-tts\"", + "audio/rvc": "\"audio/rvc\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.engine" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "file_format=$FERN_INPUT", + "values": { + "safetensors": "\"safetensors\"", + "pt": "\"pt\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.file_format" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "trigger_words=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "data.trigger_words" + }, + "type": "iterable" + } + } + ], + "type": "generic" + }, + "vae": { + "imports": [ + "from octoai.asset_library import Data_Vae" + ], + "isOptional": true, + "templateString": "data=Data_Vae($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "data_type=$FERN_INPUT", + "values": { + "fp16": "\"fp16\"", + "fp32": "\"fp32\"", + "int4": "\"int4\"", + "int8": "\"int8\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.data_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "values": { + "text/llama-2-7b": "\"text/llama-2-7b\"", + "text/llama-2-13b": "\"text/llama-2-13b\"", + "text/llama-2-70b": "\"text/llama-2-70b\"", + "text/codellama-7b": "\"text/codellama-7b\"", + "text/codellama-13b": "\"text/codellama-13b\"", + "text/codellama-34b": "\"text/codellama-34b\"", + "text/codellama-70b": "\"text/codellama-70b\"", + "text/mistral-7b": "\"text/mistral-7b\"", + "text/mixtral-8x7b": "\"text/mixtral-8x7b\"", + "image/controlnet-sd15": "\"image/controlnet-sd15\"", + "image/controlnet-sdxl": "\"image/controlnet-sdxl\"", + "image/stable-diffusion-v1-5": "\"image/stable-diffusion-v1-5\"", + "image/stable-diffusion-xl-v1-0": "\"image/stable-diffusion-xl-v1-0\"", + "image/stable-diffusion-ssd": "\"image/stable-diffusion-ssd\"", + "audio/tortoise-tts": "\"audio/tortoise-tts\"", + "audio/rvc": "\"audio/rvc\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.engine" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "file_format=$FERN_INPUT", + "values": { + "safetensors": "\"safetensors\"", + "pt": "\"pt\"" + }, + "templateInput": { + "location": "BODY", + "path": "data.file_format" + }, + "type": "enum" + } + } + ], + "type": "generic" + } + }, + "type": "discriminatedUnion" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "description=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "description", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "hf_repo=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "hf_repo", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "hf_token_secret=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "hf_token_secret", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "is_public=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "is_public", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "name", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "skip_validation=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "skip_validation", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "transfer_api_type=$FERN_INPUT", + "values": { + "presigned-url": "\"presigned-url\"", + "sts": "\"sts\"" + }, + "templateInput": { + "location": "BODY", + "path": "transfer_api_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "url=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "url", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_asset-library.delete": { + "id": "endpoint_asset-library.delete", + "namespace": [ + "subpackage_asset-library" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v1/assets/" + }, + { + "type": "pathParameter", + "value": "asset_id" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "pathParameters": [ + { + "key": "asset_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:DeleteAssetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/assets/asset_id", + "responseStatusCode": 200, + "pathParameters": { + "asset_id": "asset_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "deleted_at": "deleted_at", + "id": "id" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.octoai.cloud/v1/assets/asset_id", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.delete(\n asset_id=\"asset_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.delete(\"asset_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/assets/:asset_id", + "responseStatusCode": 422, + "pathParameters": { + "asset_id": ":asset_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.octoai.cloud/v1/assets/:asset_id", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.delete(\n asset_id=\"asset_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.delete(\"asset_id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.assetLibrary.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "asset_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.asset_library.delete(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "asset_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "PATH", + "path": "asset_id", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_asset-library.completeUpload": { + "id": "endpoint_asset-library.completeUpload", + "namespace": [ + "subpackage_asset-library" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/assets/" + }, + { + "type": "pathParameter", + "value": "asset_id" + }, + { + "type": "literal", + "value": "/complete-upload" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "pathParameters": [ + { + "key": "asset_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "skip_validation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Skip asset validation." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "" + } + } + }, + "description": "Unused" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:CompleteAssetUploadResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/assets/asset_id/complete-upload", + "responseStatusCode": 200, + "pathParameters": { + "asset_id": "asset_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "error" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/assets/asset_id/complete-upload \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.complete_upload(\n asset_id=\"asset_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.completeUpload(\"asset_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/assets/:asset_id/complete-upload", + "responseStatusCode": 422, + "pathParameters": { + "asset_id": ":asset_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/assets/:asset_id/complete-upload \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.complete_upload(\n asset_id=\"asset_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.completeUpload(\"asset_id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.assetLibrary.completeUpload(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "asset_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "skipValidation: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "skip_validation" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "token: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "token" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.asset_library.complete_upload(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "asset_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "PATH", + "path": "asset_id", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "skip_validation=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "skip_validation", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "token=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "token", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_asset-library.get": { + "id": "endpoint_asset-library.get", + "namespace": [ + "subpackage_asset-library" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/assets/" + }, + { + "type": "pathParameter", + "value": "asset_owner_and_name_or_id" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "pathParameters": [ + { + "key": "asset_owner_and_name_or_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "transfer_api_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:TransferApiType" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:RetrieveAssetResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_asset-library:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/assets/:asset_owner_and_name_or_id", + "responseStatusCode": 200, + "pathParameters": { + "asset_owner_and_name_or_id": ":asset_owner_and_name_or_id" + }, + "queryParameters": { + "transfer_api_type": "presigned-url" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "asset": { + "asset_type": "file", + "created_at": "string", + "data": { + "asset_type": "checkpoint", + "engine": "text/llama-2-7b", + "data_type": "fp16", + "file_format": "safetensors" + }, + "description": "string", + "id": "string", + "name": "string", + "size_bytes": 0, + "status": "ready_to_upload", + "status_details": "string", + "tenant_uuid": "string", + "file_structure": "unknown", + "hf_repo": "string", + "is_public": true, + "status_info": { + "string": {} + }, + "url": "string" + }, + "transfer_api": { + "type": "none" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.octoai.cloud/v1/assets/:asset_owner_and_name_or_id \\\n -d transfer_api_type=presigned-url", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.get(\n asset_owner_and_name_or_id=\"string\",\n transfer_api_type=\"presigned-url\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient, OctoAI } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.get(\"string\", {\n transferApiType: OctoAI.TransferApiType.PresignedUrl\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/assets/:asset_owner_and_name_or_id", + "responseStatusCode": 422, + "pathParameters": { + "asset_owner_and_name_or_id": ":asset_owner_and_name_or_id" + }, + "queryParameters": { + "transfer_api_type": "presigned-url" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.octoai.cloud/v1/assets/:asset_owner_and_name_or_id \\\n -d transfer_api_type=presigned-url", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.asset_library.get(\n asset_owner_and_name_or_id=\"string\",\n transfer_api_type=\"presigned-url\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient, OctoAI } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.assetLibrary.get(\"string\", {\n transferApiType: OctoAI.TransferApiType.PresignedUrl\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.assetLibrary.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "asset_owner_and_name_or_id" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "presigned-url": "OctoAI.TransferApiType.PresignedUrl", + "sts": "OctoAI.TransferApiType.Sts" + }, + "templateString": "transferApiType: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "transfer_api_type" + } + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.asset_library.get(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "asset_owner_and_name_or_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "PATH", + "path": "asset_owner_and_name_or_id", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "transfer_api_type=$FERN_INPUT", + "values": { + "presigned-url": "\"presigned-url\"", + "sts": "\"sts\"" + }, + "templateInput": { + "location": "QUERY", + "path": "transfer_api_type" + }, + "type": "enum" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_fine-tuning.create": { + "id": "endpoint_fine-tuning.create", + "namespace": [ + "subpackage_fine-tuning" + ], + "description": "Spawn a tune.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/tune" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "continue_on_rejection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "details", + "valueShape": { + "type": "id", + "id": "type_fine-tuning:Details" + }, + "description": "Details of the tune." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the tune." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:Tune" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/tune", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "details": { + "tune_type": "lora_tune", + "base_checkpoint": { + "checkpoint_id": "string" + }, + "files": [ + { + "file_id": "string" + } + ], + "steps": 0, + "trigger_words": [ + "string" + ] + }, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "created_at": "2023-01-01T00:00:00Z", + "description": "string", + "details": { + "tune_type": "lora_tune", + "base_checkpoint": { + "checkpoint_id": "string", + "engine": "text/llama-2-7b", + "name": "string" + }, + "files": [ + { + "file_id": "string", + "caption": "string" + } + ], + "steps": 0, + "trigger_words": [ + "string" + ], + "resize_images": true, + "seed": 0 + }, + "id": "string", + "name": "string", + "output_lora_ids": [ + "string" + ], + "status": "pending", + "status_details": "string", + "tenant_id": "string", + "tune_type": "lora_tune", + "updated_at": "2023-01-01T00:00:00Z", + "deleted_at": "2023-01-01T00:00:00Z", + "result": { + "number_of_available_assets": 0, + "output_assets": [ + "string" + ], + "rejected_assets": [ + "string" + ], + "unready_assets": [ + "string" + ] + }, + "succeeded_at": "2023-01-01T00:00:00Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/tune \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"details\": {\n \"tune_type\": \"lora_tune\",\n \"base_checkpoint\": {\n \"checkpoint_id\": \"string\"\n },\n \"files\": [\n {\n \"file_id\": \"string\"\n }\n ],\n \"steps\": 0,\n \"trigger_words\": [\n \"string\"\n ]\n },\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.fine_tuning import (\n Details_LoraTune,\n LoraTuneCheckpoint,\n LoraTuneFile,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.create(\n continue_on_rejection=True,\n description=\"string\",\n details=Details_LoraTune(\n base_checkpoint=LoraTuneCheckpoint(),\n files=[LoraTuneFile()],\n resize_images=True,\n seed=1,\n steps=1,\n trigger_words=[\"string\"],\n ),\n name=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.create({\n continueOnRejection: true,\n description: \"string\",\n details: {\n tuneType: \"lora_tune\",\n baseCheckpoint: {},\n files: [{}],\n resizeImages: true,\n seed: 1,\n steps: 1,\n triggerWords: [\"string\"]\n },\n name: \"string\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/tune", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "details": { + "tune_type": "lora_tune", + "base_checkpoint": { + "checkpoint_id": "string" + }, + "files": [ + { + "file_id": "string" + } + ], + "steps": 0, + "trigger_words": [ + "string" + ] + }, + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/tune \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"details\": {\n \"tune_type\": \"lora_tune\",\n \"base_checkpoint\": {\n \"checkpoint_id\": \"string\"\n },\n \"files\": [\n {\n \"file_id\": \"string\"\n }\n ],\n \"steps\": 0,\n \"trigger_words\": [\n \"string\"\n ]\n },\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.fine_tuning import (\n Details_LoraTune,\n LoraTuneCheckpoint,\n LoraTuneFile,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.create(\n continue_on_rejection=True,\n description=\"string\",\n details=Details_LoraTune(\n base_checkpoint=LoraTuneCheckpoint(),\n files=[LoraTuneFile()],\n resize_images=True,\n seed=1,\n steps=1,\n trigger_words=[\"string\"],\n ),\n name=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.create({\n continueOnRejection: true,\n description: \"string\",\n details: {\n tuneType: \"lora_tune\",\n baseCheckpoint: {},\n files: [{}],\n resizeImages: true,\n seed: 1,\n steps: 1,\n triggerWords: [\"string\"]\n },\n name: \"string\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.fineTuning.create(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "continueOnRejection: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "continue_on_rejection" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "description: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "description" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "discriminatedUnion", + "imports": [], + "isOptional": true, + "templateString": "details: '$FERN_INPUT'", + "discriminantField": "tune_type", + "members": { + "lora_tune": { + "type": "generic", + "imports": [], + "templateString": "details: { \n\t\t\ttuneType : \"lora_tune\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "baseCheckpoint: {\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "checkpointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "details.base_checkpoint.checkpoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "text/llama-2-7b": "OctoAI.BaseEngine.TextLlama27B", + "text/llama-2-13b": "OctoAI.BaseEngine.TextLlama213B", + "text/llama-2-70b": "OctoAI.BaseEngine.TextLlama270B", + "text/codellama-7b": "OctoAI.BaseEngine.TextCodellama7B", + "text/codellama-13b": "OctoAI.BaseEngine.TextCodellama13B", + "text/codellama-34b": "OctoAI.BaseEngine.TextCodellama34B", + "text/codellama-70b": "OctoAI.BaseEngine.TextCodellama70B", + "text/mistral-7b": "OctoAI.BaseEngine.TextMistral7B", + "text/mixtral-8x7b": "OctoAI.BaseEngine.TextMixtral8X7B", + "image/controlnet-sd15": "OctoAI.BaseEngine.ImageControlnetSd15", + "image/controlnet-sdxl": "OctoAI.BaseEngine.ImageControlnetSdxl", + "image/stable-diffusion-v1-5": "OctoAI.BaseEngine.ImageStableDiffusionV15", + "image/stable-diffusion-xl-v1-0": "OctoAI.BaseEngine.ImageStableDiffusionXlV10", + "image/stable-diffusion-ssd": "OctoAI.BaseEngine.ImageStableDiffusionSsd", + "audio/tortoise-tts": "OctoAI.BaseEngine.AudioTortoiseTts", + "audio/rvc": "OctoAI.BaseEngine.AudioRvc" + }, + "templateString": "engine: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "details.base_checkpoint.engine" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "details.base_checkpoint.name" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "files: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t\t\t$FERN_INPUT\n\t\t\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "caption: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "caption" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fileId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "file_id" + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "details.files" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "resizeImages: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "details.resize_images" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "details.seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "steps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "details.steps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "triggerWords: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "details.trigger_words" + } + } + } + ] + } + } + ] + }, + "text_to_speech_latent_tune": { + "type": "generic", + "imports": [], + "templateString": "details: { \n\t\t\ttuneType : \"text_to_speech_latent_tune\", \n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "assetIds: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "details.asset_ids" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "inlineAssets: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "details.inline_assets" + } + ] + } + } + ] + } + } + ] + } + }, + "templateInput": { + "location": "BODY", + "path": "details" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "name" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.fine_tuning.create(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "continue_on_rejection=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "continue_on_rejection", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "description=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "description", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "details=$FERN_INPUT", + "discriminantField": "tune_type", + "members": { + "lora_tune": { + "imports": [ + "from octoai.fine_tuning import Details_LoraTune" + ], + "isOptional": true, + "templateString": "details=Details_LoraTune($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [ + "from octoai.fine_tuning import LoraTuneCheckpoint" + ], + "isOptional": true, + "templateString": "base_checkpoint=LoraTuneCheckpoint(\n\t\t$FERN_INPUT\n\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "checkpoint_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "details.base_checkpoint.checkpoint_id", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "values": { + "text/llama-2-7b": "\"text/llama-2-7b\"", + "text/llama-2-13b": "\"text/llama-2-13b\"", + "text/llama-2-70b": "\"text/llama-2-70b\"", + "text/codellama-7b": "\"text/codellama-7b\"", + "text/codellama-13b": "\"text/codellama-13b\"", + "text/codellama-34b": "\"text/codellama-34b\"", + "text/codellama-70b": "\"text/codellama-70b\"", + "text/mistral-7b": "\"text/mistral-7b\"", + "text/mixtral-8x7b": "\"text/mixtral-8x7b\"", + "image/controlnet-sd15": "\"image/controlnet-sd15\"", + "image/controlnet-sdxl": "\"image/controlnet-sdxl\"", + "image/stable-diffusion-v1-5": "\"image/stable-diffusion-v1-5\"", + "image/stable-diffusion-xl-v1-0": "\"image/stable-diffusion-xl-v1-0\"", + "image/stable-diffusion-ssd": "\"image/stable-diffusion-ssd\"", + "audio/tortoise-tts": "\"audio/tortoise-tts\"", + "audio/rvc": "\"audio/rvc\"" + }, + "templateInput": { + "location": "BODY", + "path": "details.base_checkpoint.checkpoint_id.base_checkpoint.engine" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "details.base_checkpoint.checkpoint_id.base_checkpoint.engine.base_checkpoint.name", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t", + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "files=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [ + "from octoai.fine_tuning import LoraTuneFile" + ], + "isOptional": true, + "templateString": "LoraTuneFile(\n\t\t\t$FERN_INPUT\n\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "caption=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "caption", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "file_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "file_id", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t", + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "details.files" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "resize_images=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "details.resize_images", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "seed=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "details.seed", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "steps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "details.steps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "trigger_words=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "details.trigger_words" + }, + "type": "iterable" + } + } + ], + "type": "generic" + }, + "text_to_speech_latent_tune": { + "imports": [ + "from octoai.fine_tuning import Details_TextToSpeechLatentTune" + ], + "isOptional": true, + "templateString": "details=Details_TextToSpeechLatentTune($FERN_INPUT, )", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "asset_ids=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "details.asset_ids" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "inline_assets=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "details.inline_assets", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "type": "generic" + } + }, + "type": "discriminatedUnion" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "name", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_fine-tuning.get": { + "id": "endpoint_fine-tuning.get", + "namespace": [ + "subpackage_fine-tuning" + ], + "description": "Get the specific tune.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/tune/" + }, + { + "type": "pathParameter", + "value": "tune_id" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "pathParameters": [ + { + "key": "tune_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the tune." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:Tune" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/tune/:tune_id", + "responseStatusCode": 200, + "pathParameters": { + "tune_id": ":tune_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "created_at": "2023-01-01T00:00:00Z", + "description": "string", + "details": { + "tune_type": "lora_tune", + "base_checkpoint": { + "checkpoint_id": "string", + "engine": "text/llama-2-7b", + "name": "string" + }, + "files": [ + { + "file_id": "string", + "caption": "string" + } + ], + "steps": 0, + "trigger_words": [ + "string" + ], + "resize_images": true, + "seed": 0 + }, + "id": "string", + "name": "string", + "output_lora_ids": [ + "string" + ], + "status": "pending", + "status_details": "string", + "tenant_id": "string", + "tune_type": "lora_tune", + "updated_at": "2023-01-01T00:00:00Z", + "deleted_at": "2023-01-01T00:00:00Z", + "result": { + "number_of_available_assets": 0, + "output_assets": [ + "string" + ], + "rejected_assets": [ + "string" + ], + "unready_assets": [ + "string" + ] + }, + "succeeded_at": "2023-01-01T00:00:00Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/tune/:tune_id", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.get(\n tune_id=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.get(\"string\");\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/tune/:tune_id", + "responseStatusCode": 422, + "pathParameters": { + "tune_id": ":tune_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/tune/:tune_id", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.get(\n tune_id=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.get(\"string\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.fineTuning.get(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "tune_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.fine_tuning.get(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "tune_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "PATH", + "path": "tune_id", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_fine-tuning.delete": { + "id": "endpoint_fine-tuning.delete", + "namespace": [ + "subpackage_fine-tuning" + ], + "description": "Delete the specified tune.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/v1/tune/" + }, + { + "type": "pathParameter", + "value": "tune_id" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "pathParameters": [ + { + "key": "tune_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the tune." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/tune/tune_id", + "responseStatusCode": 200, + "pathParameters": { + "tune_id": "tune_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "string": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.octoai.cloud/v1/tune/tune_id", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.delete(\n tune_id=\"tune_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.delete(\"tune_id\");\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/tune/:tune_id", + "responseStatusCode": 422, + "pathParameters": { + "tune_id": ":tune_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.octoai.cloud/v1/tune/:tune_id", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.delete(\n tune_id=\"tune_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.delete(\"tune_id\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.fineTuning.delete(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "tune_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.fine_tuning.delete(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "tune_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "PATH", + "path": "tune_id", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_fine-tuning.cancel": { + "id": "endpoint_fine-tuning.cancel", + "namespace": [ + "subpackage_fine-tuning" + ], + "description": "Cancel the specified tune.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/tune/" + }, + { + "type": "pathParameter", + "value": "tune_id" + }, + { + "type": "literal", + "value": "/cancel" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "pathParameters": [ + { + "key": "tune_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the tune to cancel." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:Tune" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/tune/:tune_id/cancel", + "responseStatusCode": 200, + "pathParameters": { + "tune_id": ":tune_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "created_at": "2023-01-01T00:00:00Z", + "description": "string", + "details": { + "tune_type": "lora_tune", + "base_checkpoint": { + "checkpoint_id": "string", + "engine": "text/llama-2-7b", + "name": "string" + }, + "files": [ + { + "file_id": "string", + "caption": "string" + } + ], + "steps": 0, + "trigger_words": [ + "string" + ], + "resize_images": true, + "seed": 0 + }, + "id": "string", + "name": "string", + "output_lora_ids": [ + "string" + ], + "status": "pending", + "status_details": "string", + "tenant_id": "string", + "tune_type": "lora_tune", + "updated_at": "2023-01-01T00:00:00Z", + "deleted_at": "2023-01-01T00:00:00Z", + "result": { + "number_of_available_assets": 0, + "output_assets": [ + "string" + ], + "rejected_assets": [ + "string" + ], + "unready_assets": [ + "string" + ] + }, + "succeeded_at": "2023-01-01T00:00:00Z" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/tune/:tune_id/cancel", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.cancel(\n tune_id=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.cancel(\"string\");\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/tune/:tune_id/cancel", + "responseStatusCode": 422, + "pathParameters": { + "tune_id": ":tune_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.octoai.cloud/v1/tune/:tune_id/cancel", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.cancel(\n tune_id=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.cancel(\"string\");\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.fineTuning.cancel(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "PATH", + "path": "tune_id" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.fine_tuning.cancel(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "tune_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "PATH", + "path": "tune_id", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_fine-tuning.list": { + "id": "endpoint_fine-tuning.list", + "namespace": [ + "subpackage_fine-tuning" + ], + "description": "List all tunes owned by the current user.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/v1/tunes" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://api.octoai.cloud" + }, + { + "id": "SecureLink", + "baseUrl": "https://api.securelink.octo.ai" + } + ], + "queryParameters": [ + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Offset into the results." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The max number of results to be shown (limit 100)." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tune to filter on." + }, + { + "key": "tune_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_fine-tuning:TuneType" + } + }, + "description": "The type of the tune to filter on." + }, + { + "key": "base_checkpoint_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The base checkpoint ID for the LoRA tune." + }, + { + "key": "trigger_words", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The trigger words to filter on." + }, + { + "key": "engine", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The engine type." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:ListTunesResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_fine-tuning:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/v1/tunes", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [], + "has_more": true, + "total": 1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.octoai.cloud/v1/tunes", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.list();\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/tunes", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "offset": 0, + "limit": 0 + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.octoai.cloud/v1/tunes \\\n -d offset=0 \\\n -d limit=0", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.fine_tuning.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.fineTuning.list();\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.fineTuning.list(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "offset: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "offset" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "limit: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "limit" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "name: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "name" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "lora_tune": "OctoAI.TuneType.LoraTune", + "text_to_speech_latent_tune": "OctoAI.TuneType.TextToSpeechLatentTune", + "text_to_speech_rvc_tune": "OctoAI.TuneType.TextToSpeechRvcTune", + "text_to_speech_tortoise_tune": "OctoAI.TuneType.TextToSpeechTortoiseTune" + }, + "templateString": "tuneType: $FERN_INPUT", + "templateInput": { + "location": "QUERY", + "path": "tune_type" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "baseCheckpointId: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "base_checkpoint_id" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "triggerWords: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "trigger_words" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "engine: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "QUERY", + "path": "engine" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.fine_tuning.list(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "offset=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "offset", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "limit=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "limit", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "name", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "tune_type=$FERN_INPUT", + "values": { + "lora_tune": "\"lora_tune\"", + "text_to_speech_latent_tune": "\"text_to_speech_latent_tune\"", + "text_to_speech_rvc_tune": "\"text_to_speech_rvc_tune\"", + "text_to_speech_tortoise_tune": "\"text_to_speech_tortoise_tune\"" + }, + "templateInput": { + "location": "QUERY", + "path": "tune_type" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "base_checkpoint_id=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "base_checkpoint_id", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "trigger_words=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "trigger_words", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "engine=$FERN_INPUT", + "templateInputs": [ + { + "location": "QUERY", + "path": "engine", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_image-gen.generateSsd": { + "id": "endpoint_image-gen.generateSsd", + "namespace": [ + "subpackage_image-gen" + ], + "description": "Generate images in response to the given request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/generate/ssd" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://image.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://image.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/generate/ssd", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "An octopus playing chess, masterpiece, photorealistic" + } + }, + "responseBody": { + "type": "json", + "value": { + "images": [ + { + "removed_for_safety": true, + "seed": 1, + "image_b64": "image_b64", + "safety_score": 1.1 + } + ], + "prediction_time_ms": 1.1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/ssd \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"An octopus playing chess, masterpiece, photorealistic\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_ssd(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSsd({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/generate/ssd", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/ssd \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_ssd(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSsd({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.imageGen.generateSsd(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "checkpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "checkpoint" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnet: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "vae: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "vae" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "textualInversions: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "loras: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "loras" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "PNDM": "OctoAI.Scheduler.Pndm", + "LMS": "OctoAI.Scheduler.Lms", + "KLMS": "OctoAI.Scheduler.Klms", + "DDIM": "OctoAI.Scheduler.Ddim", + "DDPM": "OctoAI.Scheduler.Ddpm", + "HEUN": "OctoAI.Scheduler.Heun", + "K_HEUN": "OctoAI.Scheduler.KHeun", + "K_EULER": "OctoAI.Scheduler.KEuler", + "K_EULER_ANCESTRAL": "OctoAI.Scheduler.KEulerAncestral", + "DPM_SOLVER_MULTISTEP": "OctoAI.Scheduler.DpmSolverMultistep", + "DPM_PLUS_PLUS_2M_KARRAS": "OctoAI.Scheduler.DpmPlusPlus2MKarras", + "DPM_SINGLE": "OctoAI.Scheduler.DpmSingle", + "DPM_2": "OctoAI.Scheduler.Dpm2", + "DPM_2_ANCESTRAL": "OctoAI.Scheduler.Dpm2Ancestral", + "DPM_PLUS_PLUS_SDE_KARRAS": "OctoAI.Scheduler.DpmPlusPlusSdeKarras", + "UNI_PC": "OctoAI.Scheduler.UniPc", + "LCM": "OctoAI.Scheduler.Lcm" + }, + "templateString": "sampler: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "sampler" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "height: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "height" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "width: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "width" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cfgScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "cfg_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "steps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "steps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numImages: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_images" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "initImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "init_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maskImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "mask_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strength: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "strength" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "base": "OctoAI.SdxlStyles.Base", + "3d-model": "OctoAI.SdxlStyles.ThreeDModel", + "analog-film": "OctoAI.SdxlStyles.AnalogFilm", + "anime": "OctoAI.SdxlStyles.Anime", + "cinematic": "OctoAI.SdxlStyles.Cinematic", + "comic-book": "OctoAI.SdxlStyles.ComicBook", + "Craft Clay": "OctoAI.SdxlStyles.CraftClay", + "modeling-compound": "OctoAI.SdxlStyles.ModelingCompound", + "digital-art": "OctoAI.SdxlStyles.DigitalArt", + "enhance": "OctoAI.SdxlStyles.Enhance", + "fantasy-art": "OctoAI.SdxlStyles.FantasyArt", + "isometric": "OctoAI.SdxlStyles.Isometric", + "line-art": "OctoAI.SdxlStyles.LineArt", + "low-poly": "OctoAI.SdxlStyles.LowPoly", + "neon-punk": "OctoAI.SdxlStyles.NeonPunk", + "origami": "OctoAI.SdxlStyles.Origami", + "photographic": "OctoAI.SdxlStyles.Photographic", + "pixel-art": "OctoAI.SdxlStyles.PixelArt", + "tile-texture": "OctoAI.SdxlStyles.TileTexture", + "Advertising": "OctoAI.SdxlStyles.Advertising", + "Food Photography": "OctoAI.SdxlStyles.FoodPhotography", + "Real Estate": "OctoAI.SdxlStyles.RealEstate", + "Abstract": "OctoAI.SdxlStyles.Abstract", + "Cubist": "OctoAI.SdxlStyles.Cubist", + "Graffiti": "OctoAI.SdxlStyles.Graffiti", + "Hyperrealism": "OctoAI.SdxlStyles.Hyperrealism", + "Impressionist": "OctoAI.SdxlStyles.Impressionist", + "Pointillism": "OctoAI.SdxlStyles.Pointillism", + "Pop Art": "OctoAI.SdxlStyles.PopArt", + "Psychedelic": "OctoAI.SdxlStyles.Psychedelic", + "Renaissance": "OctoAI.SdxlStyles.Renaissance", + "Steampunk": "OctoAI.SdxlStyles.Steampunk", + "Surrealist": "OctoAI.SdxlStyles.Surrealist", + "Typography": "OctoAI.SdxlStyles.Typography", + "Watercolor": "OctoAI.SdxlStyles.Watercolor", + "Fighting Game": "OctoAI.SdxlStyles.FightingGame", + "GTA": "OctoAI.SdxlStyles.Gta", + "Super Mario": "OctoAI.SdxlStyles.SuperMario", + "Minecraft": "OctoAI.SdxlStyles.Minecraft", + "Pokémon": "OctoAI.SdxlStyles.Pokemon", + "Retro Arcade": "OctoAI.SdxlStyles.RetroArcade", + "Retro Game": "OctoAI.SdxlStyles.RetroGame", + "RPG Fantasy Game": "OctoAI.SdxlStyles.RpgFantasyGame", + "Strategy Game": "OctoAI.SdxlStyles.StrategyGame", + "Street Fighter": "OctoAI.SdxlStyles.StreetFighter", + "Legend of Zelda": "OctoAI.SdxlStyles.LegendOfZelda", + "Architectural": "OctoAI.SdxlStyles.Architectural", + "Disco": "OctoAI.SdxlStyles.Disco", + "Dreamscape": "OctoAI.SdxlStyles.Dreamscape", + "Dystopian": "OctoAI.SdxlStyles.Dystopian", + "Fairy Tale": "OctoAI.SdxlStyles.FairyTale", + "Gothic": "OctoAI.SdxlStyles.Gothic", + "Grunge": "OctoAI.SdxlStyles.Grunge", + "Horror": "OctoAI.SdxlStyles.Horror", + "Minimalist": "OctoAI.SdxlStyles.Minimalist", + "Monochrome": "OctoAI.SdxlStyles.Monochrome", + "Nautical": "OctoAI.SdxlStyles.Nautical", + "Space": "OctoAI.SdxlStyles.Space", + "Stained Glass": "OctoAI.SdxlStyles.StainedGlass", + "Techwear Fashion": "OctoAI.SdxlStyles.TechwearFashion", + "Tribal": "OctoAI.SdxlStyles.Tribal", + "Zentangle": "OctoAI.SdxlStyles.Zentangle", + "Collage": "OctoAI.SdxlStyles.Collage", + "Flat Papercut": "OctoAI.SdxlStyles.FlatPapercut", + "Kirigami": "OctoAI.SdxlStyles.Kirigami", + "Paper Mache": "OctoAI.SdxlStyles.PaperMache", + "Paper Quilling": "OctoAI.SdxlStyles.PaperQuilling", + "Papercut Collage": "OctoAI.SdxlStyles.PapercutCollage", + "Papercut Shadow Box": "OctoAI.SdxlStyles.PapercutShadowBox", + "Stacked Papercut": "OctoAI.SdxlStyles.StackedPapercut", + "Thick Layered Papercut": "OctoAI.SdxlStyles.ThickLayeredPapercut", + "Alien": "OctoAI.SdxlStyles.Alien", + "Film Noir": "OctoAI.SdxlStyles.FilmNoir", + "HDR": "OctoAI.SdxlStyles.Hdr", + "Long Exposure": "OctoAI.SdxlStyles.LongExposure", + "Neon Noir": "OctoAI.SdxlStyles.NeonNoir", + "Silhouette": "OctoAI.SdxlStyles.Silhouette", + "Tilt-Shift": "OctoAI.SdxlStyles.TiltShift" + }, + "templateString": "stylePreset: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "style_preset" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "useRefiner: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "use_refiner" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "highNoiseFrac: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "high_noise_frac" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetConditioningScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_conditioning_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetEarlyStop: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_early_stop" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetPreprocess: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_preprocess" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "clipSkip: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "clip_skip" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outpainting: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "outpainting" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "enableSafety: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "enable_safety" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "jpeg": "OctoAI.ImageEncoding.Jpeg", + "png": "OctoAI.ImageEncoding.Png" + }, + "templateString": "imageEncoding: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "image_encoding" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "transferImages: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "transfer_images" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetDownload: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_download" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetGpuCopy: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_gpu_copy" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.image_gen.generate_ssd(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "checkpoint=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "checkpoint", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "vae=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "vae", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "textual_inversions={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "loras={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "loras" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "sampler=$FERN_INPUT", + "values": { + "PNDM": "\"PNDM\"", + "LMS": "\"LMS\"", + "KLMS": "\"KLMS\"", + "DDIM": "\"DDIM\"", + "DDPM": "\"DDPM\"", + "HEUN": "\"HEUN\"", + "K_HEUN": "\"K_HEUN\"", + "K_EULER": "\"K_EULER\"", + "K_EULER_ANCESTRAL": "\"K_EULER_ANCESTRAL\"", + "DPM_SOLVER_MULTISTEP": "\"DPM_SOLVER_MULTISTEP\"", + "DPM_PLUS_PLUS_2M_KARRAS": "\"DPM_PLUS_PLUS_2M_KARRAS\"", + "DPM_SINGLE": "\"DPM_SINGLE\"", + "DPM_2": "\"DPM_2\"", + "DPM_2_ANCESTRAL": "\"DPM_2_ANCESTRAL\"", + "DPM_PLUS_PLUS_SDE_KARRAS": "\"DPM_PLUS_PLUS_SDE_KARRAS\"", + "UNI_PC": "\"UNI_PC\"", + "LCM": "\"LCM\"" + }, + "templateInput": { + "location": "BODY", + "path": "sampler" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "height=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "height", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "width=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "width", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "cfg_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "cfg_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "steps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "steps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "num_images=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "num_images", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "init_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "init_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "mask_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "mask_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "strength=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "strength", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "style_preset=$FERN_INPUT", + "values": { + "base": "\"base\"", + "3d-model": "\"3d-model\"", + "analog-film": "\"analog-film\"", + "anime": "\"anime\"", + "cinematic": "\"cinematic\"", + "comic-book": "\"comic-book\"", + "Craft Clay": "\"Craft Clay\"", + "modeling-compound": "\"modeling-compound\"", + "digital-art": "\"digital-art\"", + "enhance": "\"enhance\"", + "fantasy-art": "\"fantasy-art\"", + "isometric": "\"isometric\"", + "line-art": "\"line-art\"", + "low-poly": "\"low-poly\"", + "neon-punk": "\"neon-punk\"", + "origami": "\"origami\"", + "photographic": "\"photographic\"", + "pixel-art": "\"pixel-art\"", + "tile-texture": "\"tile-texture\"", + "Advertising": "\"Advertising\"", + "Food Photography": "\"Food Photography\"", + "Real Estate": "\"Real Estate\"", + "Abstract": "\"Abstract\"", + "Cubist": "\"Cubist\"", + "Graffiti": "\"Graffiti\"", + "Hyperrealism": "\"Hyperrealism\"", + "Impressionist": "\"Impressionist\"", + "Pointillism": "\"Pointillism\"", + "Pop Art": "\"Pop Art\"", + "Psychedelic": "\"Psychedelic\"", + "Renaissance": "\"Renaissance\"", + "Steampunk": "\"Steampunk\"", + "Surrealist": "\"Surrealist\"", + "Typography": "\"Typography\"", + "Watercolor": "\"Watercolor\"", + "Fighting Game": "\"Fighting Game\"", + "GTA": "\"GTA\"", + "Super Mario": "\"Super Mario\"", + "Minecraft": "\"Minecraft\"", + "Pokémon": "\"Pokémon\"", + "Retro Arcade": "\"Retro Arcade\"", + "Retro Game": "\"Retro Game\"", + "RPG Fantasy Game": "\"RPG Fantasy Game\"", + "Strategy Game": "\"Strategy Game\"", + "Street Fighter": "\"Street Fighter\"", + "Legend of Zelda": "\"Legend of Zelda\"", + "Architectural": "\"Architectural\"", + "Disco": "\"Disco\"", + "Dreamscape": "\"Dreamscape\"", + "Dystopian": "\"Dystopian\"", + "Fairy Tale": "\"Fairy Tale\"", + "Gothic": "\"Gothic\"", + "Grunge": "\"Grunge\"", + "Horror": "\"Horror\"", + "Minimalist": "\"Minimalist\"", + "Monochrome": "\"Monochrome\"", + "Nautical": "\"Nautical\"", + "Space": "\"Space\"", + "Stained Glass": "\"Stained Glass\"", + "Techwear Fashion": "\"Techwear Fashion\"", + "Tribal": "\"Tribal\"", + "Zentangle": "\"Zentangle\"", + "Collage": "\"Collage\"", + "Flat Papercut": "\"Flat Papercut\"", + "Kirigami": "\"Kirigami\"", + "Paper Mache": "\"Paper Mache\"", + "Paper Quilling": "\"Paper Quilling\"", + "Papercut Collage": "\"Papercut Collage\"", + "Papercut Shadow Box": "\"Papercut Shadow Box\"", + "Stacked Papercut": "\"Stacked Papercut\"", + "Thick Layered Papercut": "\"Thick Layered Papercut\"", + "Alien": "\"Alien\"", + "Film Noir": "\"Film Noir\"", + "HDR": "\"HDR\"", + "Long Exposure": "\"Long Exposure\"", + "Neon Noir": "\"Neon Noir\"", + "Silhouette": "\"Silhouette\"", + "Tilt-Shift": "\"Tilt-Shift\"" + }, + "templateInput": { + "location": "BODY", + "path": "style_preset" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "use_refiner=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "use_refiner", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "high_noise_frac=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "high_noise_frac", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_conditioning_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_conditioning_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_early_stop=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_early_stop", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_preprocess=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_preprocess", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "clip_skip=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "clip_skip", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "outpainting=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "outpainting", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "enable_safety=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "enable_safety", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "image_encoding=$FERN_INPUT", + "values": { + "jpeg": "\"jpeg\"", + "png": "\"png\"" + }, + "templateInput": { + "location": "BODY", + "path": "image_encoding" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "transfer_images={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "RELATIVE", + "path": null + }, + "type": "iterable" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "transfer_images" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_download=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_download", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_gpu_copy=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_gpu_copy", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_image-gen.generateControlnetSdxl": { + "id": "endpoint_image-gen.generateControlnetSdxl", + "namespace": [ + "subpackage_image-gen" + ], + "description": "Generate images in response to the given request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/generate/controlnet-sdxl" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://image.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://image.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/generate/controlnet-sdxl", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "An octopus playing chess, masterpiece, photorealistic" + } + }, + "responseBody": { + "type": "json", + "value": { + "images": [ + { + "removed_for_safety": true, + "seed": 1, + "image_b64": "image_b64", + "safety_score": 1.1 + } + ], + "prediction_time_ms": 1.1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/controlnet-sdxl \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"An octopus playing chess, masterpiece, photorealistic\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_controlnet_sdxl(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateControlnetSdxl({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/generate/controlnet-sdxl", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/controlnet-sdxl \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_controlnet_sdxl(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateControlnetSdxl({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.imageGen.generateControlnetSdxl(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "checkpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "checkpoint" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnet: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "vae: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "vae" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "textualInversions: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "loras: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "loras" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "PNDM": "OctoAI.Scheduler.Pndm", + "LMS": "OctoAI.Scheduler.Lms", + "KLMS": "OctoAI.Scheduler.Klms", + "DDIM": "OctoAI.Scheduler.Ddim", + "DDPM": "OctoAI.Scheduler.Ddpm", + "HEUN": "OctoAI.Scheduler.Heun", + "K_HEUN": "OctoAI.Scheduler.KHeun", + "K_EULER": "OctoAI.Scheduler.KEuler", + "K_EULER_ANCESTRAL": "OctoAI.Scheduler.KEulerAncestral", + "DPM_SOLVER_MULTISTEP": "OctoAI.Scheduler.DpmSolverMultistep", + "DPM_PLUS_PLUS_2M_KARRAS": "OctoAI.Scheduler.DpmPlusPlus2MKarras", + "DPM_SINGLE": "OctoAI.Scheduler.DpmSingle", + "DPM_2": "OctoAI.Scheduler.Dpm2", + "DPM_2_ANCESTRAL": "OctoAI.Scheduler.Dpm2Ancestral", + "DPM_PLUS_PLUS_SDE_KARRAS": "OctoAI.Scheduler.DpmPlusPlusSdeKarras", + "UNI_PC": "OctoAI.Scheduler.UniPc", + "LCM": "OctoAI.Scheduler.Lcm" + }, + "templateString": "sampler: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "sampler" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "height: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "height" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "width: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "width" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cfgScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "cfg_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "steps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "steps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numImages: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_images" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "initImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "init_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maskImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "mask_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strength: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "strength" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "base": "OctoAI.SdxlStyles.Base", + "3d-model": "OctoAI.SdxlStyles.ThreeDModel", + "analog-film": "OctoAI.SdxlStyles.AnalogFilm", + "anime": "OctoAI.SdxlStyles.Anime", + "cinematic": "OctoAI.SdxlStyles.Cinematic", + "comic-book": "OctoAI.SdxlStyles.ComicBook", + "Craft Clay": "OctoAI.SdxlStyles.CraftClay", + "modeling-compound": "OctoAI.SdxlStyles.ModelingCompound", + "digital-art": "OctoAI.SdxlStyles.DigitalArt", + "enhance": "OctoAI.SdxlStyles.Enhance", + "fantasy-art": "OctoAI.SdxlStyles.FantasyArt", + "isometric": "OctoAI.SdxlStyles.Isometric", + "line-art": "OctoAI.SdxlStyles.LineArt", + "low-poly": "OctoAI.SdxlStyles.LowPoly", + "neon-punk": "OctoAI.SdxlStyles.NeonPunk", + "origami": "OctoAI.SdxlStyles.Origami", + "photographic": "OctoAI.SdxlStyles.Photographic", + "pixel-art": "OctoAI.SdxlStyles.PixelArt", + "tile-texture": "OctoAI.SdxlStyles.TileTexture", + "Advertising": "OctoAI.SdxlStyles.Advertising", + "Food Photography": "OctoAI.SdxlStyles.FoodPhotography", + "Real Estate": "OctoAI.SdxlStyles.RealEstate", + "Abstract": "OctoAI.SdxlStyles.Abstract", + "Cubist": "OctoAI.SdxlStyles.Cubist", + "Graffiti": "OctoAI.SdxlStyles.Graffiti", + "Hyperrealism": "OctoAI.SdxlStyles.Hyperrealism", + "Impressionist": "OctoAI.SdxlStyles.Impressionist", + "Pointillism": "OctoAI.SdxlStyles.Pointillism", + "Pop Art": "OctoAI.SdxlStyles.PopArt", + "Psychedelic": "OctoAI.SdxlStyles.Psychedelic", + "Renaissance": "OctoAI.SdxlStyles.Renaissance", + "Steampunk": "OctoAI.SdxlStyles.Steampunk", + "Surrealist": "OctoAI.SdxlStyles.Surrealist", + "Typography": "OctoAI.SdxlStyles.Typography", + "Watercolor": "OctoAI.SdxlStyles.Watercolor", + "Fighting Game": "OctoAI.SdxlStyles.FightingGame", + "GTA": "OctoAI.SdxlStyles.Gta", + "Super Mario": "OctoAI.SdxlStyles.SuperMario", + "Minecraft": "OctoAI.SdxlStyles.Minecraft", + "Pokémon": "OctoAI.SdxlStyles.Pokemon", + "Retro Arcade": "OctoAI.SdxlStyles.RetroArcade", + "Retro Game": "OctoAI.SdxlStyles.RetroGame", + "RPG Fantasy Game": "OctoAI.SdxlStyles.RpgFantasyGame", + "Strategy Game": "OctoAI.SdxlStyles.StrategyGame", + "Street Fighter": "OctoAI.SdxlStyles.StreetFighter", + "Legend of Zelda": "OctoAI.SdxlStyles.LegendOfZelda", + "Architectural": "OctoAI.SdxlStyles.Architectural", + "Disco": "OctoAI.SdxlStyles.Disco", + "Dreamscape": "OctoAI.SdxlStyles.Dreamscape", + "Dystopian": "OctoAI.SdxlStyles.Dystopian", + "Fairy Tale": "OctoAI.SdxlStyles.FairyTale", + "Gothic": "OctoAI.SdxlStyles.Gothic", + "Grunge": "OctoAI.SdxlStyles.Grunge", + "Horror": "OctoAI.SdxlStyles.Horror", + "Minimalist": "OctoAI.SdxlStyles.Minimalist", + "Monochrome": "OctoAI.SdxlStyles.Monochrome", + "Nautical": "OctoAI.SdxlStyles.Nautical", + "Space": "OctoAI.SdxlStyles.Space", + "Stained Glass": "OctoAI.SdxlStyles.StainedGlass", + "Techwear Fashion": "OctoAI.SdxlStyles.TechwearFashion", + "Tribal": "OctoAI.SdxlStyles.Tribal", + "Zentangle": "OctoAI.SdxlStyles.Zentangle", + "Collage": "OctoAI.SdxlStyles.Collage", + "Flat Papercut": "OctoAI.SdxlStyles.FlatPapercut", + "Kirigami": "OctoAI.SdxlStyles.Kirigami", + "Paper Mache": "OctoAI.SdxlStyles.PaperMache", + "Paper Quilling": "OctoAI.SdxlStyles.PaperQuilling", + "Papercut Collage": "OctoAI.SdxlStyles.PapercutCollage", + "Papercut Shadow Box": "OctoAI.SdxlStyles.PapercutShadowBox", + "Stacked Papercut": "OctoAI.SdxlStyles.StackedPapercut", + "Thick Layered Papercut": "OctoAI.SdxlStyles.ThickLayeredPapercut", + "Alien": "OctoAI.SdxlStyles.Alien", + "Film Noir": "OctoAI.SdxlStyles.FilmNoir", + "HDR": "OctoAI.SdxlStyles.Hdr", + "Long Exposure": "OctoAI.SdxlStyles.LongExposure", + "Neon Noir": "OctoAI.SdxlStyles.NeonNoir", + "Silhouette": "OctoAI.SdxlStyles.Silhouette", + "Tilt-Shift": "OctoAI.SdxlStyles.TiltShift" + }, + "templateString": "stylePreset: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "style_preset" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "useRefiner: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "use_refiner" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "highNoiseFrac: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "high_noise_frac" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetConditioningScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_conditioning_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetEarlyStop: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_early_stop" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetPreprocess: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_preprocess" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "clipSkip: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "clip_skip" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outpainting: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "outpainting" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "enableSafety: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "enable_safety" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "jpeg": "OctoAI.ImageEncoding.Jpeg", + "png": "OctoAI.ImageEncoding.Png" + }, + "templateString": "imageEncoding: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "image_encoding" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "transferImages: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "transfer_images" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetDownload: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_download" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetGpuCopy: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_gpu_copy" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.image_gen.generate_controlnet_sdxl(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "checkpoint=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "checkpoint", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "vae=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "vae", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "textual_inversions={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "loras={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "loras" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "sampler=$FERN_INPUT", + "values": { + "PNDM": "\"PNDM\"", + "LMS": "\"LMS\"", + "KLMS": "\"KLMS\"", + "DDIM": "\"DDIM\"", + "DDPM": "\"DDPM\"", + "HEUN": "\"HEUN\"", + "K_HEUN": "\"K_HEUN\"", + "K_EULER": "\"K_EULER\"", + "K_EULER_ANCESTRAL": "\"K_EULER_ANCESTRAL\"", + "DPM_SOLVER_MULTISTEP": "\"DPM_SOLVER_MULTISTEP\"", + "DPM_PLUS_PLUS_2M_KARRAS": "\"DPM_PLUS_PLUS_2M_KARRAS\"", + "DPM_SINGLE": "\"DPM_SINGLE\"", + "DPM_2": "\"DPM_2\"", + "DPM_2_ANCESTRAL": "\"DPM_2_ANCESTRAL\"", + "DPM_PLUS_PLUS_SDE_KARRAS": "\"DPM_PLUS_PLUS_SDE_KARRAS\"", + "UNI_PC": "\"UNI_PC\"", + "LCM": "\"LCM\"" + }, + "templateInput": { + "location": "BODY", + "path": "sampler" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "height=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "height", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "width=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "width", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "cfg_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "cfg_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "steps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "steps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "num_images=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "num_images", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "init_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "init_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "mask_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "mask_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "strength=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "strength", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "style_preset=$FERN_INPUT", + "values": { + "base": "\"base\"", + "3d-model": "\"3d-model\"", + "analog-film": "\"analog-film\"", + "anime": "\"anime\"", + "cinematic": "\"cinematic\"", + "comic-book": "\"comic-book\"", + "Craft Clay": "\"Craft Clay\"", + "modeling-compound": "\"modeling-compound\"", + "digital-art": "\"digital-art\"", + "enhance": "\"enhance\"", + "fantasy-art": "\"fantasy-art\"", + "isometric": "\"isometric\"", + "line-art": "\"line-art\"", + "low-poly": "\"low-poly\"", + "neon-punk": "\"neon-punk\"", + "origami": "\"origami\"", + "photographic": "\"photographic\"", + "pixel-art": "\"pixel-art\"", + "tile-texture": "\"tile-texture\"", + "Advertising": "\"Advertising\"", + "Food Photography": "\"Food Photography\"", + "Real Estate": "\"Real Estate\"", + "Abstract": "\"Abstract\"", + "Cubist": "\"Cubist\"", + "Graffiti": "\"Graffiti\"", + "Hyperrealism": "\"Hyperrealism\"", + "Impressionist": "\"Impressionist\"", + "Pointillism": "\"Pointillism\"", + "Pop Art": "\"Pop Art\"", + "Psychedelic": "\"Psychedelic\"", + "Renaissance": "\"Renaissance\"", + "Steampunk": "\"Steampunk\"", + "Surrealist": "\"Surrealist\"", + "Typography": "\"Typography\"", + "Watercolor": "\"Watercolor\"", + "Fighting Game": "\"Fighting Game\"", + "GTA": "\"GTA\"", + "Super Mario": "\"Super Mario\"", + "Minecraft": "\"Minecraft\"", + "Pokémon": "\"Pokémon\"", + "Retro Arcade": "\"Retro Arcade\"", + "Retro Game": "\"Retro Game\"", + "RPG Fantasy Game": "\"RPG Fantasy Game\"", + "Strategy Game": "\"Strategy Game\"", + "Street Fighter": "\"Street Fighter\"", + "Legend of Zelda": "\"Legend of Zelda\"", + "Architectural": "\"Architectural\"", + "Disco": "\"Disco\"", + "Dreamscape": "\"Dreamscape\"", + "Dystopian": "\"Dystopian\"", + "Fairy Tale": "\"Fairy Tale\"", + "Gothic": "\"Gothic\"", + "Grunge": "\"Grunge\"", + "Horror": "\"Horror\"", + "Minimalist": "\"Minimalist\"", + "Monochrome": "\"Monochrome\"", + "Nautical": "\"Nautical\"", + "Space": "\"Space\"", + "Stained Glass": "\"Stained Glass\"", + "Techwear Fashion": "\"Techwear Fashion\"", + "Tribal": "\"Tribal\"", + "Zentangle": "\"Zentangle\"", + "Collage": "\"Collage\"", + "Flat Papercut": "\"Flat Papercut\"", + "Kirigami": "\"Kirigami\"", + "Paper Mache": "\"Paper Mache\"", + "Paper Quilling": "\"Paper Quilling\"", + "Papercut Collage": "\"Papercut Collage\"", + "Papercut Shadow Box": "\"Papercut Shadow Box\"", + "Stacked Papercut": "\"Stacked Papercut\"", + "Thick Layered Papercut": "\"Thick Layered Papercut\"", + "Alien": "\"Alien\"", + "Film Noir": "\"Film Noir\"", + "HDR": "\"HDR\"", + "Long Exposure": "\"Long Exposure\"", + "Neon Noir": "\"Neon Noir\"", + "Silhouette": "\"Silhouette\"", + "Tilt-Shift": "\"Tilt-Shift\"" + }, + "templateInput": { + "location": "BODY", + "path": "style_preset" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "use_refiner=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "use_refiner", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "high_noise_frac=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "high_noise_frac", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_conditioning_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_conditioning_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_early_stop=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_early_stop", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_preprocess=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_preprocess", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "clip_skip=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "clip_skip", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "outpainting=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "outpainting", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "enable_safety=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "enable_safety", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "image_encoding=$FERN_INPUT", + "values": { + "jpeg": "\"jpeg\"", + "png": "\"png\"" + }, + "templateInput": { + "location": "BODY", + "path": "image_encoding" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "transfer_images={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "RELATIVE", + "path": null + }, + "type": "iterable" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "transfer_images" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_download=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_download", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_gpu_copy=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_gpu_copy", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_image-gen.generateControlnetSd15": { + "id": "endpoint_image-gen.generateControlnetSd15", + "namespace": [ + "subpackage_image-gen" + ], + "description": "Generate images in response to the given request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/generate/controlnet-sd15" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://image.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://image.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/generate/controlnet-sd15", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "An octopus playing chess, masterpiece, photorealistic" + } + }, + "responseBody": { + "type": "json", + "value": { + "images": [ + { + "removed_for_safety": true, + "seed": 1, + "image_b64": "image_b64", + "safety_score": 1.1 + } + ], + "prediction_time_ms": 1.1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/controlnet-sd15 \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"An octopus playing chess, masterpiece, photorealistic\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_controlnet_sd15(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateControlnetSd15({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/generate/controlnet-sd15", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/controlnet-sd15 \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_controlnet_sd15(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateControlnetSd15({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.imageGen.generateControlnetSd15(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "checkpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "checkpoint" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnet: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "vae: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "vae" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "textualInversions: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "loras: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "loras" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "PNDM": "OctoAI.Scheduler.Pndm", + "LMS": "OctoAI.Scheduler.Lms", + "KLMS": "OctoAI.Scheduler.Klms", + "DDIM": "OctoAI.Scheduler.Ddim", + "DDPM": "OctoAI.Scheduler.Ddpm", + "HEUN": "OctoAI.Scheduler.Heun", + "K_HEUN": "OctoAI.Scheduler.KHeun", + "K_EULER": "OctoAI.Scheduler.KEuler", + "K_EULER_ANCESTRAL": "OctoAI.Scheduler.KEulerAncestral", + "DPM_SOLVER_MULTISTEP": "OctoAI.Scheduler.DpmSolverMultistep", + "DPM_PLUS_PLUS_2M_KARRAS": "OctoAI.Scheduler.DpmPlusPlus2MKarras", + "DPM_SINGLE": "OctoAI.Scheduler.DpmSingle", + "DPM_2": "OctoAI.Scheduler.Dpm2", + "DPM_2_ANCESTRAL": "OctoAI.Scheduler.Dpm2Ancestral", + "DPM_PLUS_PLUS_SDE_KARRAS": "OctoAI.Scheduler.DpmPlusPlusSdeKarras", + "UNI_PC": "OctoAI.Scheduler.UniPc", + "LCM": "OctoAI.Scheduler.Lcm" + }, + "templateString": "sampler: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "sampler" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "height: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "height" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "width: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "width" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cfgScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "cfg_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "steps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "steps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numImages: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_images" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "initImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "init_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maskImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "mask_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strength: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "strength" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "base": "OctoAI.SdxlStyles.Base", + "3d-model": "OctoAI.SdxlStyles.ThreeDModel", + "analog-film": "OctoAI.SdxlStyles.AnalogFilm", + "anime": "OctoAI.SdxlStyles.Anime", + "cinematic": "OctoAI.SdxlStyles.Cinematic", + "comic-book": "OctoAI.SdxlStyles.ComicBook", + "Craft Clay": "OctoAI.SdxlStyles.CraftClay", + "modeling-compound": "OctoAI.SdxlStyles.ModelingCompound", + "digital-art": "OctoAI.SdxlStyles.DigitalArt", + "enhance": "OctoAI.SdxlStyles.Enhance", + "fantasy-art": "OctoAI.SdxlStyles.FantasyArt", + "isometric": "OctoAI.SdxlStyles.Isometric", + "line-art": "OctoAI.SdxlStyles.LineArt", + "low-poly": "OctoAI.SdxlStyles.LowPoly", + "neon-punk": "OctoAI.SdxlStyles.NeonPunk", + "origami": "OctoAI.SdxlStyles.Origami", + "photographic": "OctoAI.SdxlStyles.Photographic", + "pixel-art": "OctoAI.SdxlStyles.PixelArt", + "tile-texture": "OctoAI.SdxlStyles.TileTexture", + "Advertising": "OctoAI.SdxlStyles.Advertising", + "Food Photography": "OctoAI.SdxlStyles.FoodPhotography", + "Real Estate": "OctoAI.SdxlStyles.RealEstate", + "Abstract": "OctoAI.SdxlStyles.Abstract", + "Cubist": "OctoAI.SdxlStyles.Cubist", + "Graffiti": "OctoAI.SdxlStyles.Graffiti", + "Hyperrealism": "OctoAI.SdxlStyles.Hyperrealism", + "Impressionist": "OctoAI.SdxlStyles.Impressionist", + "Pointillism": "OctoAI.SdxlStyles.Pointillism", + "Pop Art": "OctoAI.SdxlStyles.PopArt", + "Psychedelic": "OctoAI.SdxlStyles.Psychedelic", + "Renaissance": "OctoAI.SdxlStyles.Renaissance", + "Steampunk": "OctoAI.SdxlStyles.Steampunk", + "Surrealist": "OctoAI.SdxlStyles.Surrealist", + "Typography": "OctoAI.SdxlStyles.Typography", + "Watercolor": "OctoAI.SdxlStyles.Watercolor", + "Fighting Game": "OctoAI.SdxlStyles.FightingGame", + "GTA": "OctoAI.SdxlStyles.Gta", + "Super Mario": "OctoAI.SdxlStyles.SuperMario", + "Minecraft": "OctoAI.SdxlStyles.Minecraft", + "Pokémon": "OctoAI.SdxlStyles.Pokemon", + "Retro Arcade": "OctoAI.SdxlStyles.RetroArcade", + "Retro Game": "OctoAI.SdxlStyles.RetroGame", + "RPG Fantasy Game": "OctoAI.SdxlStyles.RpgFantasyGame", + "Strategy Game": "OctoAI.SdxlStyles.StrategyGame", + "Street Fighter": "OctoAI.SdxlStyles.StreetFighter", + "Legend of Zelda": "OctoAI.SdxlStyles.LegendOfZelda", + "Architectural": "OctoAI.SdxlStyles.Architectural", + "Disco": "OctoAI.SdxlStyles.Disco", + "Dreamscape": "OctoAI.SdxlStyles.Dreamscape", + "Dystopian": "OctoAI.SdxlStyles.Dystopian", + "Fairy Tale": "OctoAI.SdxlStyles.FairyTale", + "Gothic": "OctoAI.SdxlStyles.Gothic", + "Grunge": "OctoAI.SdxlStyles.Grunge", + "Horror": "OctoAI.SdxlStyles.Horror", + "Minimalist": "OctoAI.SdxlStyles.Minimalist", + "Monochrome": "OctoAI.SdxlStyles.Monochrome", + "Nautical": "OctoAI.SdxlStyles.Nautical", + "Space": "OctoAI.SdxlStyles.Space", + "Stained Glass": "OctoAI.SdxlStyles.StainedGlass", + "Techwear Fashion": "OctoAI.SdxlStyles.TechwearFashion", + "Tribal": "OctoAI.SdxlStyles.Tribal", + "Zentangle": "OctoAI.SdxlStyles.Zentangle", + "Collage": "OctoAI.SdxlStyles.Collage", + "Flat Papercut": "OctoAI.SdxlStyles.FlatPapercut", + "Kirigami": "OctoAI.SdxlStyles.Kirigami", + "Paper Mache": "OctoAI.SdxlStyles.PaperMache", + "Paper Quilling": "OctoAI.SdxlStyles.PaperQuilling", + "Papercut Collage": "OctoAI.SdxlStyles.PapercutCollage", + "Papercut Shadow Box": "OctoAI.SdxlStyles.PapercutShadowBox", + "Stacked Papercut": "OctoAI.SdxlStyles.StackedPapercut", + "Thick Layered Papercut": "OctoAI.SdxlStyles.ThickLayeredPapercut", + "Alien": "OctoAI.SdxlStyles.Alien", + "Film Noir": "OctoAI.SdxlStyles.FilmNoir", + "HDR": "OctoAI.SdxlStyles.Hdr", + "Long Exposure": "OctoAI.SdxlStyles.LongExposure", + "Neon Noir": "OctoAI.SdxlStyles.NeonNoir", + "Silhouette": "OctoAI.SdxlStyles.Silhouette", + "Tilt-Shift": "OctoAI.SdxlStyles.TiltShift" + }, + "templateString": "stylePreset: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "style_preset" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "useRefiner: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "use_refiner" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "highNoiseFrac: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "high_noise_frac" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetConditioningScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_conditioning_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetEarlyStop: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_early_stop" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetPreprocess: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_preprocess" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "clipSkip: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "clip_skip" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outpainting: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "outpainting" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "enableSafety: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "enable_safety" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "jpeg": "OctoAI.ImageEncoding.Jpeg", + "png": "OctoAI.ImageEncoding.Png" + }, + "templateString": "imageEncoding: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "image_encoding" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "transferImages: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "transfer_images" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetDownload: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_download" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetGpuCopy: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_gpu_copy" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.image_gen.generate_controlnet_sd15(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "checkpoint=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "checkpoint", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "vae=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "vae", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "textual_inversions={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "loras={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "loras" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "sampler=$FERN_INPUT", + "values": { + "PNDM": "\"PNDM\"", + "LMS": "\"LMS\"", + "KLMS": "\"KLMS\"", + "DDIM": "\"DDIM\"", + "DDPM": "\"DDPM\"", + "HEUN": "\"HEUN\"", + "K_HEUN": "\"K_HEUN\"", + "K_EULER": "\"K_EULER\"", + "K_EULER_ANCESTRAL": "\"K_EULER_ANCESTRAL\"", + "DPM_SOLVER_MULTISTEP": "\"DPM_SOLVER_MULTISTEP\"", + "DPM_PLUS_PLUS_2M_KARRAS": "\"DPM_PLUS_PLUS_2M_KARRAS\"", + "DPM_SINGLE": "\"DPM_SINGLE\"", + "DPM_2": "\"DPM_2\"", + "DPM_2_ANCESTRAL": "\"DPM_2_ANCESTRAL\"", + "DPM_PLUS_PLUS_SDE_KARRAS": "\"DPM_PLUS_PLUS_SDE_KARRAS\"", + "UNI_PC": "\"UNI_PC\"", + "LCM": "\"LCM\"" + }, + "templateInput": { + "location": "BODY", + "path": "sampler" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "height=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "height", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "width=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "width", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "cfg_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "cfg_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "steps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "steps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "num_images=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "num_images", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "init_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "init_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "mask_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "mask_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "strength=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "strength", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "style_preset=$FERN_INPUT", + "values": { + "base": "\"base\"", + "3d-model": "\"3d-model\"", + "analog-film": "\"analog-film\"", + "anime": "\"anime\"", + "cinematic": "\"cinematic\"", + "comic-book": "\"comic-book\"", + "Craft Clay": "\"Craft Clay\"", + "modeling-compound": "\"modeling-compound\"", + "digital-art": "\"digital-art\"", + "enhance": "\"enhance\"", + "fantasy-art": "\"fantasy-art\"", + "isometric": "\"isometric\"", + "line-art": "\"line-art\"", + "low-poly": "\"low-poly\"", + "neon-punk": "\"neon-punk\"", + "origami": "\"origami\"", + "photographic": "\"photographic\"", + "pixel-art": "\"pixel-art\"", + "tile-texture": "\"tile-texture\"", + "Advertising": "\"Advertising\"", + "Food Photography": "\"Food Photography\"", + "Real Estate": "\"Real Estate\"", + "Abstract": "\"Abstract\"", + "Cubist": "\"Cubist\"", + "Graffiti": "\"Graffiti\"", + "Hyperrealism": "\"Hyperrealism\"", + "Impressionist": "\"Impressionist\"", + "Pointillism": "\"Pointillism\"", + "Pop Art": "\"Pop Art\"", + "Psychedelic": "\"Psychedelic\"", + "Renaissance": "\"Renaissance\"", + "Steampunk": "\"Steampunk\"", + "Surrealist": "\"Surrealist\"", + "Typography": "\"Typography\"", + "Watercolor": "\"Watercolor\"", + "Fighting Game": "\"Fighting Game\"", + "GTA": "\"GTA\"", + "Super Mario": "\"Super Mario\"", + "Minecraft": "\"Minecraft\"", + "Pokémon": "\"Pokémon\"", + "Retro Arcade": "\"Retro Arcade\"", + "Retro Game": "\"Retro Game\"", + "RPG Fantasy Game": "\"RPG Fantasy Game\"", + "Strategy Game": "\"Strategy Game\"", + "Street Fighter": "\"Street Fighter\"", + "Legend of Zelda": "\"Legend of Zelda\"", + "Architectural": "\"Architectural\"", + "Disco": "\"Disco\"", + "Dreamscape": "\"Dreamscape\"", + "Dystopian": "\"Dystopian\"", + "Fairy Tale": "\"Fairy Tale\"", + "Gothic": "\"Gothic\"", + "Grunge": "\"Grunge\"", + "Horror": "\"Horror\"", + "Minimalist": "\"Minimalist\"", + "Monochrome": "\"Monochrome\"", + "Nautical": "\"Nautical\"", + "Space": "\"Space\"", + "Stained Glass": "\"Stained Glass\"", + "Techwear Fashion": "\"Techwear Fashion\"", + "Tribal": "\"Tribal\"", + "Zentangle": "\"Zentangle\"", + "Collage": "\"Collage\"", + "Flat Papercut": "\"Flat Papercut\"", + "Kirigami": "\"Kirigami\"", + "Paper Mache": "\"Paper Mache\"", + "Paper Quilling": "\"Paper Quilling\"", + "Papercut Collage": "\"Papercut Collage\"", + "Papercut Shadow Box": "\"Papercut Shadow Box\"", + "Stacked Papercut": "\"Stacked Papercut\"", + "Thick Layered Papercut": "\"Thick Layered Papercut\"", + "Alien": "\"Alien\"", + "Film Noir": "\"Film Noir\"", + "HDR": "\"HDR\"", + "Long Exposure": "\"Long Exposure\"", + "Neon Noir": "\"Neon Noir\"", + "Silhouette": "\"Silhouette\"", + "Tilt-Shift": "\"Tilt-Shift\"" + }, + "templateInput": { + "location": "BODY", + "path": "style_preset" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "use_refiner=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "use_refiner", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "high_noise_frac=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "high_noise_frac", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_conditioning_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_conditioning_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_early_stop=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_early_stop", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_preprocess=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_preprocess", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "clip_skip=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "clip_skip", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "outpainting=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "outpainting", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "enable_safety=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "enable_safety", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "image_encoding=$FERN_INPUT", + "values": { + "jpeg": "\"jpeg\"", + "png": "\"png\"" + }, + "templateInput": { + "location": "BODY", + "path": "image_encoding" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "transfer_images={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "RELATIVE", + "path": null + }, + "type": "iterable" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "transfer_images" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_download=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_download", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_gpu_copy=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_gpu_copy", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_image-gen.generateSdxl": { + "id": "endpoint_image-gen.generateSdxl", + "namespace": [ + "subpackage_image-gen" + ], + "description": "Generate images in response to the given request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/generate/sdxl" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://image.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://image.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/generate/sdxl", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "An octopus playing chess, masterpiece, photorealistic" + } + }, + "responseBody": { + "type": "json", + "value": { + "images": [ + { + "removed_for_safety": true, + "seed": 1, + "image_b64": "image_b64", + "safety_score": 1.1 + } + ], + "prediction_time_ms": 1.1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/sdxl \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"An octopus playing chess, masterpiece, photorealistic\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_sdxl(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSdxl({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/generate/sdxl", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/sdxl \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_sdxl(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSdxl({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.imageGen.generateSdxl(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "checkpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "checkpoint" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnet: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "vae: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "vae" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "textualInversions: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "loras: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "loras" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "PNDM": "OctoAI.Scheduler.Pndm", + "LMS": "OctoAI.Scheduler.Lms", + "KLMS": "OctoAI.Scheduler.Klms", + "DDIM": "OctoAI.Scheduler.Ddim", + "DDPM": "OctoAI.Scheduler.Ddpm", + "HEUN": "OctoAI.Scheduler.Heun", + "K_HEUN": "OctoAI.Scheduler.KHeun", + "K_EULER": "OctoAI.Scheduler.KEuler", + "K_EULER_ANCESTRAL": "OctoAI.Scheduler.KEulerAncestral", + "DPM_SOLVER_MULTISTEP": "OctoAI.Scheduler.DpmSolverMultistep", + "DPM_PLUS_PLUS_2M_KARRAS": "OctoAI.Scheduler.DpmPlusPlus2MKarras", + "DPM_SINGLE": "OctoAI.Scheduler.DpmSingle", + "DPM_2": "OctoAI.Scheduler.Dpm2", + "DPM_2_ANCESTRAL": "OctoAI.Scheduler.Dpm2Ancestral", + "DPM_PLUS_PLUS_SDE_KARRAS": "OctoAI.Scheduler.DpmPlusPlusSdeKarras", + "UNI_PC": "OctoAI.Scheduler.UniPc", + "LCM": "OctoAI.Scheduler.Lcm" + }, + "templateString": "sampler: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "sampler" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "height: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "height" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "width: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "width" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cfgScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "cfg_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "steps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "steps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numImages: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_images" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "initImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "init_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maskImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "mask_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strength: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "strength" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "base": "OctoAI.SdxlStyles.Base", + "3d-model": "OctoAI.SdxlStyles.ThreeDModel", + "analog-film": "OctoAI.SdxlStyles.AnalogFilm", + "anime": "OctoAI.SdxlStyles.Anime", + "cinematic": "OctoAI.SdxlStyles.Cinematic", + "comic-book": "OctoAI.SdxlStyles.ComicBook", + "Craft Clay": "OctoAI.SdxlStyles.CraftClay", + "modeling-compound": "OctoAI.SdxlStyles.ModelingCompound", + "digital-art": "OctoAI.SdxlStyles.DigitalArt", + "enhance": "OctoAI.SdxlStyles.Enhance", + "fantasy-art": "OctoAI.SdxlStyles.FantasyArt", + "isometric": "OctoAI.SdxlStyles.Isometric", + "line-art": "OctoAI.SdxlStyles.LineArt", + "low-poly": "OctoAI.SdxlStyles.LowPoly", + "neon-punk": "OctoAI.SdxlStyles.NeonPunk", + "origami": "OctoAI.SdxlStyles.Origami", + "photographic": "OctoAI.SdxlStyles.Photographic", + "pixel-art": "OctoAI.SdxlStyles.PixelArt", + "tile-texture": "OctoAI.SdxlStyles.TileTexture", + "Advertising": "OctoAI.SdxlStyles.Advertising", + "Food Photography": "OctoAI.SdxlStyles.FoodPhotography", + "Real Estate": "OctoAI.SdxlStyles.RealEstate", + "Abstract": "OctoAI.SdxlStyles.Abstract", + "Cubist": "OctoAI.SdxlStyles.Cubist", + "Graffiti": "OctoAI.SdxlStyles.Graffiti", + "Hyperrealism": "OctoAI.SdxlStyles.Hyperrealism", + "Impressionist": "OctoAI.SdxlStyles.Impressionist", + "Pointillism": "OctoAI.SdxlStyles.Pointillism", + "Pop Art": "OctoAI.SdxlStyles.PopArt", + "Psychedelic": "OctoAI.SdxlStyles.Psychedelic", + "Renaissance": "OctoAI.SdxlStyles.Renaissance", + "Steampunk": "OctoAI.SdxlStyles.Steampunk", + "Surrealist": "OctoAI.SdxlStyles.Surrealist", + "Typography": "OctoAI.SdxlStyles.Typography", + "Watercolor": "OctoAI.SdxlStyles.Watercolor", + "Fighting Game": "OctoAI.SdxlStyles.FightingGame", + "GTA": "OctoAI.SdxlStyles.Gta", + "Super Mario": "OctoAI.SdxlStyles.SuperMario", + "Minecraft": "OctoAI.SdxlStyles.Minecraft", + "Pokémon": "OctoAI.SdxlStyles.Pokemon", + "Retro Arcade": "OctoAI.SdxlStyles.RetroArcade", + "Retro Game": "OctoAI.SdxlStyles.RetroGame", + "RPG Fantasy Game": "OctoAI.SdxlStyles.RpgFantasyGame", + "Strategy Game": "OctoAI.SdxlStyles.StrategyGame", + "Street Fighter": "OctoAI.SdxlStyles.StreetFighter", + "Legend of Zelda": "OctoAI.SdxlStyles.LegendOfZelda", + "Architectural": "OctoAI.SdxlStyles.Architectural", + "Disco": "OctoAI.SdxlStyles.Disco", + "Dreamscape": "OctoAI.SdxlStyles.Dreamscape", + "Dystopian": "OctoAI.SdxlStyles.Dystopian", + "Fairy Tale": "OctoAI.SdxlStyles.FairyTale", + "Gothic": "OctoAI.SdxlStyles.Gothic", + "Grunge": "OctoAI.SdxlStyles.Grunge", + "Horror": "OctoAI.SdxlStyles.Horror", + "Minimalist": "OctoAI.SdxlStyles.Minimalist", + "Monochrome": "OctoAI.SdxlStyles.Monochrome", + "Nautical": "OctoAI.SdxlStyles.Nautical", + "Space": "OctoAI.SdxlStyles.Space", + "Stained Glass": "OctoAI.SdxlStyles.StainedGlass", + "Techwear Fashion": "OctoAI.SdxlStyles.TechwearFashion", + "Tribal": "OctoAI.SdxlStyles.Tribal", + "Zentangle": "OctoAI.SdxlStyles.Zentangle", + "Collage": "OctoAI.SdxlStyles.Collage", + "Flat Papercut": "OctoAI.SdxlStyles.FlatPapercut", + "Kirigami": "OctoAI.SdxlStyles.Kirigami", + "Paper Mache": "OctoAI.SdxlStyles.PaperMache", + "Paper Quilling": "OctoAI.SdxlStyles.PaperQuilling", + "Papercut Collage": "OctoAI.SdxlStyles.PapercutCollage", + "Papercut Shadow Box": "OctoAI.SdxlStyles.PapercutShadowBox", + "Stacked Papercut": "OctoAI.SdxlStyles.StackedPapercut", + "Thick Layered Papercut": "OctoAI.SdxlStyles.ThickLayeredPapercut", + "Alien": "OctoAI.SdxlStyles.Alien", + "Film Noir": "OctoAI.SdxlStyles.FilmNoir", + "HDR": "OctoAI.SdxlStyles.Hdr", + "Long Exposure": "OctoAI.SdxlStyles.LongExposure", + "Neon Noir": "OctoAI.SdxlStyles.NeonNoir", + "Silhouette": "OctoAI.SdxlStyles.Silhouette", + "Tilt-Shift": "OctoAI.SdxlStyles.TiltShift" + }, + "templateString": "stylePreset: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "style_preset" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "useRefiner: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "use_refiner" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "highNoiseFrac: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "high_noise_frac" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetConditioningScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_conditioning_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetEarlyStop: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_early_stop" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetPreprocess: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_preprocess" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "clipSkip: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "clip_skip" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outpainting: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "outpainting" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "enableSafety: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "enable_safety" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "jpeg": "OctoAI.ImageEncoding.Jpeg", + "png": "OctoAI.ImageEncoding.Png" + }, + "templateString": "imageEncoding: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "image_encoding" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "transferImages: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "transfer_images" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetDownload: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_download" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetGpuCopy: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_gpu_copy" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.image_gen.generate_sdxl(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "checkpoint=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "checkpoint", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "vae=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "vae", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "textual_inversions={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "loras={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "loras" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "sampler=$FERN_INPUT", + "values": { + "PNDM": "\"PNDM\"", + "LMS": "\"LMS\"", + "KLMS": "\"KLMS\"", + "DDIM": "\"DDIM\"", + "DDPM": "\"DDPM\"", + "HEUN": "\"HEUN\"", + "K_HEUN": "\"K_HEUN\"", + "K_EULER": "\"K_EULER\"", + "K_EULER_ANCESTRAL": "\"K_EULER_ANCESTRAL\"", + "DPM_SOLVER_MULTISTEP": "\"DPM_SOLVER_MULTISTEP\"", + "DPM_PLUS_PLUS_2M_KARRAS": "\"DPM_PLUS_PLUS_2M_KARRAS\"", + "DPM_SINGLE": "\"DPM_SINGLE\"", + "DPM_2": "\"DPM_2\"", + "DPM_2_ANCESTRAL": "\"DPM_2_ANCESTRAL\"", + "DPM_PLUS_PLUS_SDE_KARRAS": "\"DPM_PLUS_PLUS_SDE_KARRAS\"", + "UNI_PC": "\"UNI_PC\"", + "LCM": "\"LCM\"" + }, + "templateInput": { + "location": "BODY", + "path": "sampler" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "height=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "height", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "width=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "width", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "cfg_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "cfg_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "steps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "steps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "num_images=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "num_images", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "init_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "init_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "mask_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "mask_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "strength=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "strength", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "style_preset=$FERN_INPUT", + "values": { + "base": "\"base\"", + "3d-model": "\"3d-model\"", + "analog-film": "\"analog-film\"", + "anime": "\"anime\"", + "cinematic": "\"cinematic\"", + "comic-book": "\"comic-book\"", + "Craft Clay": "\"Craft Clay\"", + "modeling-compound": "\"modeling-compound\"", + "digital-art": "\"digital-art\"", + "enhance": "\"enhance\"", + "fantasy-art": "\"fantasy-art\"", + "isometric": "\"isometric\"", + "line-art": "\"line-art\"", + "low-poly": "\"low-poly\"", + "neon-punk": "\"neon-punk\"", + "origami": "\"origami\"", + "photographic": "\"photographic\"", + "pixel-art": "\"pixel-art\"", + "tile-texture": "\"tile-texture\"", + "Advertising": "\"Advertising\"", + "Food Photography": "\"Food Photography\"", + "Real Estate": "\"Real Estate\"", + "Abstract": "\"Abstract\"", + "Cubist": "\"Cubist\"", + "Graffiti": "\"Graffiti\"", + "Hyperrealism": "\"Hyperrealism\"", + "Impressionist": "\"Impressionist\"", + "Pointillism": "\"Pointillism\"", + "Pop Art": "\"Pop Art\"", + "Psychedelic": "\"Psychedelic\"", + "Renaissance": "\"Renaissance\"", + "Steampunk": "\"Steampunk\"", + "Surrealist": "\"Surrealist\"", + "Typography": "\"Typography\"", + "Watercolor": "\"Watercolor\"", + "Fighting Game": "\"Fighting Game\"", + "GTA": "\"GTA\"", + "Super Mario": "\"Super Mario\"", + "Minecraft": "\"Minecraft\"", + "Pokémon": "\"Pokémon\"", + "Retro Arcade": "\"Retro Arcade\"", + "Retro Game": "\"Retro Game\"", + "RPG Fantasy Game": "\"RPG Fantasy Game\"", + "Strategy Game": "\"Strategy Game\"", + "Street Fighter": "\"Street Fighter\"", + "Legend of Zelda": "\"Legend of Zelda\"", + "Architectural": "\"Architectural\"", + "Disco": "\"Disco\"", + "Dreamscape": "\"Dreamscape\"", + "Dystopian": "\"Dystopian\"", + "Fairy Tale": "\"Fairy Tale\"", + "Gothic": "\"Gothic\"", + "Grunge": "\"Grunge\"", + "Horror": "\"Horror\"", + "Minimalist": "\"Minimalist\"", + "Monochrome": "\"Monochrome\"", + "Nautical": "\"Nautical\"", + "Space": "\"Space\"", + "Stained Glass": "\"Stained Glass\"", + "Techwear Fashion": "\"Techwear Fashion\"", + "Tribal": "\"Tribal\"", + "Zentangle": "\"Zentangle\"", + "Collage": "\"Collage\"", + "Flat Papercut": "\"Flat Papercut\"", + "Kirigami": "\"Kirigami\"", + "Paper Mache": "\"Paper Mache\"", + "Paper Quilling": "\"Paper Quilling\"", + "Papercut Collage": "\"Papercut Collage\"", + "Papercut Shadow Box": "\"Papercut Shadow Box\"", + "Stacked Papercut": "\"Stacked Papercut\"", + "Thick Layered Papercut": "\"Thick Layered Papercut\"", + "Alien": "\"Alien\"", + "Film Noir": "\"Film Noir\"", + "HDR": "\"HDR\"", + "Long Exposure": "\"Long Exposure\"", + "Neon Noir": "\"Neon Noir\"", + "Silhouette": "\"Silhouette\"", + "Tilt-Shift": "\"Tilt-Shift\"" + }, + "templateInput": { + "location": "BODY", + "path": "style_preset" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "use_refiner=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "use_refiner", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "high_noise_frac=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "high_noise_frac", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_conditioning_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_conditioning_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_early_stop=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_early_stop", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_preprocess=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_preprocess", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "clip_skip=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "clip_skip", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "outpainting=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "outpainting", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "enable_safety=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "enable_safety", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "image_encoding=$FERN_INPUT", + "values": { + "jpeg": "\"jpeg\"", + "png": "\"png\"" + }, + "templateInput": { + "location": "BODY", + "path": "image_encoding" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "transfer_images={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "RELATIVE", + "path": null + }, + "type": "iterable" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "transfer_images" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_download=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_download", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_gpu_copy=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_gpu_copy", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_image-gen.generateSd": { + "id": "endpoint_image-gen.generateSd", + "namespace": [ + "subpackage_image-gen" + ], + "description": "Generate images in response to the given request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/generate/sd" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://image.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://image.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:ImageGenerationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/generate/sd", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "An octopus playing chess, masterpiece, photorealistic" + } + }, + "responseBody": { + "type": "json", + "value": { + "images": [ + { + "removed_for_safety": true, + "seed": 1, + "image_b64": "image_b64", + "safety_score": 1.1 + } + ], + "prediction_time_ms": 1.1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/sd \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"An octopus playing chess, masterpiece, photorealistic\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_sd(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSd({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/generate/sd", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "prompt": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/sd \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"prompt\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_sd(\n prompt=\"An octopus playing chess, masterpiece, photorealistic\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSd({\n prompt: \"An octopus playing chess, masterpiece, photorealistic\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.imageGen.generateSd(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "prompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "negativePrompt2: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "negative_prompt_2" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "checkpoint: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "checkpoint" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnet: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "vae: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "vae" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "textualInversions: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "loras: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "loras" + } + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "PNDM": "OctoAI.Scheduler.Pndm", + "LMS": "OctoAI.Scheduler.Lms", + "KLMS": "OctoAI.Scheduler.Klms", + "DDIM": "OctoAI.Scheduler.Ddim", + "DDPM": "OctoAI.Scheduler.Ddpm", + "HEUN": "OctoAI.Scheduler.Heun", + "K_HEUN": "OctoAI.Scheduler.KHeun", + "K_EULER": "OctoAI.Scheduler.KEuler", + "K_EULER_ANCESTRAL": "OctoAI.Scheduler.KEulerAncestral", + "DPM_SOLVER_MULTISTEP": "OctoAI.Scheduler.DpmSolverMultistep", + "DPM_PLUS_PLUS_2M_KARRAS": "OctoAI.Scheduler.DpmPlusPlus2MKarras", + "DPM_SINGLE": "OctoAI.Scheduler.DpmSingle", + "DPM_2": "OctoAI.Scheduler.Dpm2", + "DPM_2_ANCESTRAL": "OctoAI.Scheduler.Dpm2Ancestral", + "DPM_PLUS_PLUS_SDE_KARRAS": "OctoAI.Scheduler.DpmPlusPlusSdeKarras", + "UNI_PC": "OctoAI.Scheduler.UniPc", + "LCM": "OctoAI.Scheduler.Lcm" + }, + "templateString": "sampler: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "sampler" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "height: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "height" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "width: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "width" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cfgScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "cfg_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "steps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "steps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numImages: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_images" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "initImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "init_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maskImage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "mask_image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "strength: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "strength" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "base": "OctoAI.SdxlStyles.Base", + "3d-model": "OctoAI.SdxlStyles.ThreeDModel", + "analog-film": "OctoAI.SdxlStyles.AnalogFilm", + "anime": "OctoAI.SdxlStyles.Anime", + "cinematic": "OctoAI.SdxlStyles.Cinematic", + "comic-book": "OctoAI.SdxlStyles.ComicBook", + "Craft Clay": "OctoAI.SdxlStyles.CraftClay", + "modeling-compound": "OctoAI.SdxlStyles.ModelingCompound", + "digital-art": "OctoAI.SdxlStyles.DigitalArt", + "enhance": "OctoAI.SdxlStyles.Enhance", + "fantasy-art": "OctoAI.SdxlStyles.FantasyArt", + "isometric": "OctoAI.SdxlStyles.Isometric", + "line-art": "OctoAI.SdxlStyles.LineArt", + "low-poly": "OctoAI.SdxlStyles.LowPoly", + "neon-punk": "OctoAI.SdxlStyles.NeonPunk", + "origami": "OctoAI.SdxlStyles.Origami", + "photographic": "OctoAI.SdxlStyles.Photographic", + "pixel-art": "OctoAI.SdxlStyles.PixelArt", + "tile-texture": "OctoAI.SdxlStyles.TileTexture", + "Advertising": "OctoAI.SdxlStyles.Advertising", + "Food Photography": "OctoAI.SdxlStyles.FoodPhotography", + "Real Estate": "OctoAI.SdxlStyles.RealEstate", + "Abstract": "OctoAI.SdxlStyles.Abstract", + "Cubist": "OctoAI.SdxlStyles.Cubist", + "Graffiti": "OctoAI.SdxlStyles.Graffiti", + "Hyperrealism": "OctoAI.SdxlStyles.Hyperrealism", + "Impressionist": "OctoAI.SdxlStyles.Impressionist", + "Pointillism": "OctoAI.SdxlStyles.Pointillism", + "Pop Art": "OctoAI.SdxlStyles.PopArt", + "Psychedelic": "OctoAI.SdxlStyles.Psychedelic", + "Renaissance": "OctoAI.SdxlStyles.Renaissance", + "Steampunk": "OctoAI.SdxlStyles.Steampunk", + "Surrealist": "OctoAI.SdxlStyles.Surrealist", + "Typography": "OctoAI.SdxlStyles.Typography", + "Watercolor": "OctoAI.SdxlStyles.Watercolor", + "Fighting Game": "OctoAI.SdxlStyles.FightingGame", + "GTA": "OctoAI.SdxlStyles.Gta", + "Super Mario": "OctoAI.SdxlStyles.SuperMario", + "Minecraft": "OctoAI.SdxlStyles.Minecraft", + "Pokémon": "OctoAI.SdxlStyles.Pokemon", + "Retro Arcade": "OctoAI.SdxlStyles.RetroArcade", + "Retro Game": "OctoAI.SdxlStyles.RetroGame", + "RPG Fantasy Game": "OctoAI.SdxlStyles.RpgFantasyGame", + "Strategy Game": "OctoAI.SdxlStyles.StrategyGame", + "Street Fighter": "OctoAI.SdxlStyles.StreetFighter", + "Legend of Zelda": "OctoAI.SdxlStyles.LegendOfZelda", + "Architectural": "OctoAI.SdxlStyles.Architectural", + "Disco": "OctoAI.SdxlStyles.Disco", + "Dreamscape": "OctoAI.SdxlStyles.Dreamscape", + "Dystopian": "OctoAI.SdxlStyles.Dystopian", + "Fairy Tale": "OctoAI.SdxlStyles.FairyTale", + "Gothic": "OctoAI.SdxlStyles.Gothic", + "Grunge": "OctoAI.SdxlStyles.Grunge", + "Horror": "OctoAI.SdxlStyles.Horror", + "Minimalist": "OctoAI.SdxlStyles.Minimalist", + "Monochrome": "OctoAI.SdxlStyles.Monochrome", + "Nautical": "OctoAI.SdxlStyles.Nautical", + "Space": "OctoAI.SdxlStyles.Space", + "Stained Glass": "OctoAI.SdxlStyles.StainedGlass", + "Techwear Fashion": "OctoAI.SdxlStyles.TechwearFashion", + "Tribal": "OctoAI.SdxlStyles.Tribal", + "Zentangle": "OctoAI.SdxlStyles.Zentangle", + "Collage": "OctoAI.SdxlStyles.Collage", + "Flat Papercut": "OctoAI.SdxlStyles.FlatPapercut", + "Kirigami": "OctoAI.SdxlStyles.Kirigami", + "Paper Mache": "OctoAI.SdxlStyles.PaperMache", + "Paper Quilling": "OctoAI.SdxlStyles.PaperQuilling", + "Papercut Collage": "OctoAI.SdxlStyles.PapercutCollage", + "Papercut Shadow Box": "OctoAI.SdxlStyles.PapercutShadowBox", + "Stacked Papercut": "OctoAI.SdxlStyles.StackedPapercut", + "Thick Layered Papercut": "OctoAI.SdxlStyles.ThickLayeredPapercut", + "Alien": "OctoAI.SdxlStyles.Alien", + "Film Noir": "OctoAI.SdxlStyles.FilmNoir", + "HDR": "OctoAI.SdxlStyles.Hdr", + "Long Exposure": "OctoAI.SdxlStyles.LongExposure", + "Neon Noir": "OctoAI.SdxlStyles.NeonNoir", + "Silhouette": "OctoAI.SdxlStyles.Silhouette", + "Tilt-Shift": "OctoAI.SdxlStyles.TiltShift" + }, + "templateString": "stylePreset: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "style_preset" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "useRefiner: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "use_refiner" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "highNoiseFrac: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "high_noise_frac" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetConditioningScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_conditioning_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetEarlyStop: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_early_stop" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "controlnetPreprocess: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "controlnet_preprocess" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "clipSkip: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "clip_skip" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "outpainting: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "outpainting" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "enableSafety: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "enable_safety" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "enum", + "imports": [], + "isOptional": true, + "values": { + "jpeg": "OctoAI.ImageEncoding.Jpeg", + "png": "OctoAI.ImageEncoding.Png" + }, + "templateString": "imageEncoding: $FERN_INPUT", + "templateInput": { + "location": "BODY", + "path": "image_encoding" + } + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "transferImages: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "RELATIVE", + "path": null + } + }, + "templateInput": { + "location": "BODY", + "path": "transfer_images" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetDownload: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_download" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetGpuCopy: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_gpu_copy" + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.image_gen.generate_sd(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "negative_prompt2=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "negative_prompt_2", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "checkpoint=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "checkpoint", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "vae=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "vae", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "textual_inversions={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "textual_inversions" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "loras={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "loras" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "sampler=$FERN_INPUT", + "values": { + "PNDM": "\"PNDM\"", + "LMS": "\"LMS\"", + "KLMS": "\"KLMS\"", + "DDIM": "\"DDIM\"", + "DDPM": "\"DDPM\"", + "HEUN": "\"HEUN\"", + "K_HEUN": "\"K_HEUN\"", + "K_EULER": "\"K_EULER\"", + "K_EULER_ANCESTRAL": "\"K_EULER_ANCESTRAL\"", + "DPM_SOLVER_MULTISTEP": "\"DPM_SOLVER_MULTISTEP\"", + "DPM_PLUS_PLUS_2M_KARRAS": "\"DPM_PLUS_PLUS_2M_KARRAS\"", + "DPM_SINGLE": "\"DPM_SINGLE\"", + "DPM_2": "\"DPM_2\"", + "DPM_2_ANCESTRAL": "\"DPM_2_ANCESTRAL\"", + "DPM_PLUS_PLUS_SDE_KARRAS": "\"DPM_PLUS_PLUS_SDE_KARRAS\"", + "UNI_PC": "\"UNI_PC\"", + "LCM": "\"LCM\"" + }, + "templateInput": { + "location": "BODY", + "path": "sampler" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "height=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "height", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "width=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "width", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "cfg_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "cfg_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "steps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "steps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "num_images=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "num_images", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "init_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "init_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "mask_image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "mask_image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "strength=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "strength", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "style_preset=$FERN_INPUT", + "values": { + "base": "\"base\"", + "3d-model": "\"3d-model\"", + "analog-film": "\"analog-film\"", + "anime": "\"anime\"", + "cinematic": "\"cinematic\"", + "comic-book": "\"comic-book\"", + "Craft Clay": "\"Craft Clay\"", + "modeling-compound": "\"modeling-compound\"", + "digital-art": "\"digital-art\"", + "enhance": "\"enhance\"", + "fantasy-art": "\"fantasy-art\"", + "isometric": "\"isometric\"", + "line-art": "\"line-art\"", + "low-poly": "\"low-poly\"", + "neon-punk": "\"neon-punk\"", + "origami": "\"origami\"", + "photographic": "\"photographic\"", + "pixel-art": "\"pixel-art\"", + "tile-texture": "\"tile-texture\"", + "Advertising": "\"Advertising\"", + "Food Photography": "\"Food Photography\"", + "Real Estate": "\"Real Estate\"", + "Abstract": "\"Abstract\"", + "Cubist": "\"Cubist\"", + "Graffiti": "\"Graffiti\"", + "Hyperrealism": "\"Hyperrealism\"", + "Impressionist": "\"Impressionist\"", + "Pointillism": "\"Pointillism\"", + "Pop Art": "\"Pop Art\"", + "Psychedelic": "\"Psychedelic\"", + "Renaissance": "\"Renaissance\"", + "Steampunk": "\"Steampunk\"", + "Surrealist": "\"Surrealist\"", + "Typography": "\"Typography\"", + "Watercolor": "\"Watercolor\"", + "Fighting Game": "\"Fighting Game\"", + "GTA": "\"GTA\"", + "Super Mario": "\"Super Mario\"", + "Minecraft": "\"Minecraft\"", + "Pokémon": "\"Pokémon\"", + "Retro Arcade": "\"Retro Arcade\"", + "Retro Game": "\"Retro Game\"", + "RPG Fantasy Game": "\"RPG Fantasy Game\"", + "Strategy Game": "\"Strategy Game\"", + "Street Fighter": "\"Street Fighter\"", + "Legend of Zelda": "\"Legend of Zelda\"", + "Architectural": "\"Architectural\"", + "Disco": "\"Disco\"", + "Dreamscape": "\"Dreamscape\"", + "Dystopian": "\"Dystopian\"", + "Fairy Tale": "\"Fairy Tale\"", + "Gothic": "\"Gothic\"", + "Grunge": "\"Grunge\"", + "Horror": "\"Horror\"", + "Minimalist": "\"Minimalist\"", + "Monochrome": "\"Monochrome\"", + "Nautical": "\"Nautical\"", + "Space": "\"Space\"", + "Stained Glass": "\"Stained Glass\"", + "Techwear Fashion": "\"Techwear Fashion\"", + "Tribal": "\"Tribal\"", + "Zentangle": "\"Zentangle\"", + "Collage": "\"Collage\"", + "Flat Papercut": "\"Flat Papercut\"", + "Kirigami": "\"Kirigami\"", + "Paper Mache": "\"Paper Mache\"", + "Paper Quilling": "\"Paper Quilling\"", + "Papercut Collage": "\"Papercut Collage\"", + "Papercut Shadow Box": "\"Papercut Shadow Box\"", + "Stacked Papercut": "\"Stacked Papercut\"", + "Thick Layered Papercut": "\"Thick Layered Papercut\"", + "Alien": "\"Alien\"", + "Film Noir": "\"Film Noir\"", + "HDR": "\"HDR\"", + "Long Exposure": "\"Long Exposure\"", + "Neon Noir": "\"Neon Noir\"", + "Silhouette": "\"Silhouette\"", + "Tilt-Shift": "\"Tilt-Shift\"" + }, + "templateInput": { + "location": "BODY", + "path": "style_preset" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "use_refiner=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "use_refiner", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "high_noise_frac=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "high_noise_frac", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_conditioning_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_conditioning_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_early_stop=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_early_stop", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "controlnet_preprocess=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "controlnet_preprocess", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "clip_skip=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "clip_skip", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "outpainting=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "outpainting", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "enable_safety=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "enable_safety", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "image_encoding=$FERN_INPUT", + "values": { + "jpeg": "\"jpeg\"", + "png": "\"png\"" + }, + "templateInput": { + "location": "BODY", + "path": "image_encoding" + }, + "type": "enum" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "transfer_images={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "containerTemplateString": "[\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "RELATIVE", + "path": null + }, + "type": "iterable" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "transfer_images" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_download=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_download", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_gpu_copy=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_gpu_copy", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_image-gen.generateSvd": { + "id": "endpoint_image-gen.generateSvd", + "namespace": [ + "subpackage_image-gen" + ], + "description": "Generate videos in response to the given request.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/generate/svd" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://image.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://image.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "image", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Starting point image encoded in base64 string." + }, + { + "key": "height", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "width", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "cfg_scale", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 10, + "default": 3 + } + } + }, + "description": "Floating-point number represeting how closely to adhere to 'image'. Must be a positive number no greater than 10.0." + }, + { + "key": "steps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "maximum": 50, + "default": 25 + } + } + }, + "description": "Integer repreenting how many steps of diffusion to run. Must be greater than 0 and less than or equal to 50." + }, + { + "key": "motion_scale", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 5, + "default": 0.5 + } + } + }, + "description": "A floating point number between 0.0 and 5.0 indicating how much motion should be in the generated video/animation." + }, + { + "key": "noise_aug_strength", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1, + "default": 0.02 + } + } + }, + "description": "A floating point number between 0.0 and 1.0 indicatiing how much noise to add to the initial image. Higher values encourage creativity." + }, + { + "key": "num_videos", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "maximum": 16, + "default": 1 + } + } + }, + "description": "Integer representing how many output videos/animations to generate with a single 'image' and configuration." + }, + { + "key": "fps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "maximum": 25, + "default": 7 + } + } + }, + "description": "Integer representing how fast the generated frames should play back." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_image-gen:VideoGenerationRequestSeed" + } + }, + "description": "Integer number or list of integers representing the seeds of random generators.Fixing random seed is useful when attempting to generate a specific video/animation (or set of videos/animations). Must be greater than 0 and less than 2^32." + }, + { + "key": "enable_safety", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Boolean defining whether to use safety checker system on generated outputs or not." + }, + { + "key": "force_asset_download", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "[Internal] Boolean defining if assets must be re-downloaded into the cache even if present." + }, + { + "key": "force_asset_gpu_copy", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "[Internal] Boolean defining if assets must to be copied into the GPU even if present." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:VideoGenerationResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_image-gen:HTTPValidationError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/generate/svd", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "image": "image" + } + }, + "responseBody": { + "type": "json", + "value": { + "videos": [ + { + "removed_for_safety": true, + "seed": 1, + "video": "video", + "safety_score": 1.1 + } + ], + "prediction_time_ms": 1.1 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/svd \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"image\": \"image\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_svd(\n image=\"image\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSvd({\n image: \"image\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/generate/svd", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "image": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://image.octoai.run/generate/svd \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"image\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.image_gen.generate_svd(\n image=\"image\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.imageGen.generateSvd({\n image: \"image\"\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.imageGen.generateSvd(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "image: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "image" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "height: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "height" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "width: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "width" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "cfgScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "cfg_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "steps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "steps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "motionScale: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "motion_scale" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "noiseAugStrength: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "noise_aug_strength" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "numVideos: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "num_videos" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "fps: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "fps" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "enableSafety: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "enable_safety" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetDownload: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_download" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "forceAssetGpuCopy: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "force_asset_gpu_copy" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.image_gen.generate_svd(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "image=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "image", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "height=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "height", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "width=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "width", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "cfg_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "cfg_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "steps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "steps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "motion_scale=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "motion_scale", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "noise_aug_strength=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "noise_aug_strength", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "num_videos=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "num_videos", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "fps=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "fps", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "enable_safety=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "enable_safety", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_download=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_download", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "force_asset_gpu_copy=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "force_asset_gpu_copy", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_text-gen.createChatCompletion_stream": { + "id": "endpoint_text-gen.createChatCompletion_stream", + "namespace": [ + "subpackage_text-gen" + ], + "description": "Create a Chat Completion.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/chat/completions" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://text.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://text.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on their frequency in the generated text so far." + }, + { + "key": "ignore_eos", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "logit_bias", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + } + }, + { + "key": "loglikelihood", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 512 + } + } + }, + "description": "Maximum number of tokens to generate per output sequence." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:ChatMessage" + } + }, + "description": "A list of messages comprising the conversation so far." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The identifier of the model to use.Can be a shared tenancy or custom model identifier." + }, + { + "key": "n", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 1 + } + } + } + }, + { + "key": "octoai", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:ChatCompletionRequestExt" + } + } + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on whether they appear in the generated text so far" + }, + { + "key": "repetition_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "Controls the likelihood of the model generating repeated texts" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:ChatCompletionResponseFormat" + } + } + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Stop" + } + } + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If set, tokens will be streamed incrementally to users." + }, + { + "key": "stream_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:StreamOptions" + } + } + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 2, + "default": 1 + } + } + }, + "description": "Controls the randomness of the sampling." + }, + { + "key": "top_logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 0 + } + } + } + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 1, + "default": 1 + } + } + }, + "description": "Controls the cumulative probability of the top tokens to consider." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:ChatCompletionChunk" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:HTTPValidationError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:ErrorResponse" + } + }, + "examples": [ + { + "responseBody": { + "type": "json", + "value": { + "message": "An example error", + "type": "internal_error", + "object": "error" + } + } + } + ] + } + ], + "examples": [ + { + "path": "/v1/chat/completions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "messages": [ + { + "role": "string" + } + ], + "model": "string", + "stream": true + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "choices": [ + { + "delta": { + "content": "string", + "role": "string" + }, + "finish_reason": "stop", + "index": 0, + "logprobs": { + "content": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string", + "top_logprobs": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string" + } + ] + } + ] + } + } + ], + "created": 0, + "id": "string", + "model": "string", + "object": {}, + "usage": { + "completion_tokens": 0, + "prompt_tokens": 0, + "total_tokens": 0 + } + }, + { + "choices": [ + { + "delta": { + "content": "string", + "role": "string" + }, + "finish_reason": "stop", + "index": 0, + "logprobs": { + "content": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string", + "top_logprobs": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string" + } + ] + } + ] + } + } + ], + "created": 0, + "id": "string", + "model": "string", + "object": {}, + "usage": { + "completion_tokens": 0, + "prompt_tokens": 0, + "total_tokens": 0 + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"messages\": [\n {\n \"role\": \"string\"\n }\n ],\n \"model\": \"string\",\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.text_gen import (\n ChatCompletionRequestExt,\n ChatCompletionRequestExtVllm,\n ChatCompletionResponseFormat,\n ChatFnCall,\n ChatMessage,\n Function,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_chat_completion_stream(\n frequency_penalty=1.1,\n function_call=\"string\",\n functions=[\n Function(\n description=\"string\",\n name=\"string\",\n parameters={\"key\": \"value\"},\n )\n ],\n ignore_eos=True,\n logit_bias={\"string\": {\"key\": \"value\"}},\n max_tokens=1,\n messages=[\n ChatMessage(\n content=\"string\",\n function_call=ChatFnCall(\n arguments=\"string\",\n name=\"string\",\n ),\n role=\"string\",\n )\n ],\n model=\"string\",\n n=1,\n octoai=ChatCompletionRequestExt(\n vllm=ChatCompletionRequestExtVllm(),\n ),\n presence_penalty=1.1,\n repetition_penalty=1.1,\n response_format=ChatCompletionResponseFormat(\n schema={\"string\": {\"key\": \"value\"}},\n type=\"string\",\n ),\n stop=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createChatCompletion({\n messages: [{\n role: \"role\"\n }],\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/chat/completions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "messages": [ + { + "role": "string" + } + ], + "model": "string", + "stream": true + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"messages\": [\n {\n \"role\": \"string\"\n }\n ],\n \"model\": \"string\",\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.text_gen import (\n ChatCompletionRequestExt,\n ChatCompletionRequestExtVllm,\n ChatCompletionResponseFormat,\n ChatFnCall,\n ChatMessage,\n Function,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_chat_completion_stream(\n frequency_penalty=1.1,\n function_call=\"string\",\n functions=[\n Function(\n description=\"string\",\n name=\"string\",\n parameters={\"key\": \"value\"},\n )\n ],\n ignore_eos=True,\n logit_bias={\"string\": {\"key\": \"value\"}},\n max_tokens=1,\n messages=[\n ChatMessage(\n content=\"string\",\n function_call=ChatFnCall(\n arguments=\"string\",\n name=\"string\",\n ),\n role=\"string\",\n )\n ],\n model=\"string\",\n n=1,\n octoai=ChatCompletionRequestExt(\n vllm=ChatCompletionRequestExtVllm(),\n ),\n presence_penalty=1.1,\n repetition_penalty=1.1,\n response_format=ChatCompletionResponseFormat(\n schema={\"string\": {\"key\": \"value\"}},\n type=\"string\",\n ),\n stop=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createChatCompletion({\n messages: [{\n role: \"role\"\n }],\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/chat/completions", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "messages": [ + { + "role": "string" + } + ], + "model": "string", + "stream": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": "string", + "message": "string", + "object": "string", + "param": "string", + "type": "string", + "validation_errors": { + "string": "string" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"messages\": [\n {\n \"role\": \"string\"\n }\n ],\n \"model\": \"string\",\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.text_gen import (\n ChatCompletionRequestExt,\n ChatCompletionRequestExtVllm,\n ChatCompletionResponseFormat,\n ChatFnCall,\n ChatMessage,\n Function,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_chat_completion_stream(\n frequency_penalty=1.1,\n function_call=\"string\",\n functions=[\n Function(\n description=\"string\",\n name=\"string\",\n parameters={\"key\": \"value\"},\n )\n ],\n ignore_eos=True,\n logit_bias={\"string\": {\"key\": \"value\"}},\n max_tokens=1,\n messages=[\n ChatMessage(\n content=\"string\",\n function_call=ChatFnCall(\n arguments=\"string\",\n name=\"string\",\n ),\n role=\"string\",\n )\n ],\n model=\"string\",\n n=1,\n octoai=ChatCompletionRequestExt(\n vllm=ChatCompletionRequestExtVllm(),\n ),\n presence_penalty=1.1,\n repetition_penalty=1.1,\n response_format=ChatCompletionResponseFormat(\n schema={\"string\": {\"key\": \"value\"}},\n type=\"string\",\n ),\n stop=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createChatCompletion({\n messages: [{\n role: \"role\"\n }],\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.textGen.createChatCompletionStream(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "ignoreEos: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "ignore_eos" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "logitBias: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "logit_bias" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "loglikelihood: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "loglikelihood" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "logprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "messages: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "content: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "content" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "role: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "role" + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "messages" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "n: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "n" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "octoai: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "vllm: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "bestOf: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.best_of" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "ignoreEos: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.ignore_eos" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "skipSpecialTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.skip_special_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "stopTokenIds: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "octoai.vllm.stop_token_ids" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topK: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.top_k" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "useBeamSearch: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.use_beam_search" + } + ] + } + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "repetitionPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "repetition_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "schema: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "response_format.schema" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "type: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "response_format.type" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "streamOptions: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "includeUsage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stream_options.include_usage" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topLogprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "top_logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.text_gen.create_chat_completion_stream(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "frequency_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "frequency_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "functions=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [ + "from octoai.text_gen import Function" + ], + "isOptional": true, + "templateString": "Function(\n\t\t\t$FERN_INPUT\n\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "description=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "description", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "name", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "parameters=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "parameters", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t", + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "functions" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "ignore_eos=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "ignore_eos", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "logit_bias={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "logit_bias" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "max_tokens=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "max_tokens", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "messages=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [ + "from octoai.text_gen import ChatMessage" + ], + "isOptional": true, + "templateString": "ChatMessage(\n\t\t\t$FERN_INPUT\n\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "content=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "content", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatFnCall" + ], + "isOptional": true, + "templateString": "function_call=ChatFnCall(\n\t\t\t\t$FERN_INPUT\n\t\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "arguments=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "function_call.arguments", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "function_call.name", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t\t", + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "role=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "role", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t", + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "messages" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "model=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "model", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "n=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "n", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatCompletionRequestExt" + ], + "isOptional": true, + "templateString": "octoai=ChatCompletionRequestExt(\n\t\t$FERN_INPUT\n\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatCompletionRequestExtVllm" + ], + "isOptional": true, + "templateString": "vllm=ChatCompletionRequestExtVllm(\n\t\t\t$FERN_INPUT\n\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "best_of=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "ignore_eos=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "skip_special_tokens=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "stop_token_ids=[\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens.vllm.stop_token_ids" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "top_k=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens.vllm.stop_token_ids.vllm.top_k", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "use_beam_search=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens.vllm.stop_token_ids.vllm.top_k.vllm.use_beam_search", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t", + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t", + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "presence_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "presence_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "repetition_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "repetition_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatCompletionResponseFormat" + ], + "isOptional": true, + "templateString": "response_format=ChatCompletionResponseFormat(\n\t\t$FERN_INPUT\n\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "schema={\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "response_format.schema" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "type=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "response_format.type", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t", + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "temperature=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "temperature", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "top_p=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "top_p", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "user=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "user", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_text-gen.createChatCompletion": { + "id": "endpoint_text-gen.createChatCompletion", + "namespace": [ + "subpackage_text-gen" + ], + "description": "Create a Chat Completion.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/chat/completions" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://text.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://text.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on their frequency in the generated text so far." + }, + { + "key": "ignore_eos", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "logit_bias", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + } + }, + { + "key": "loglikelihood", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 512 + } + } + }, + "description": "Maximum number of tokens to generate per output sequence." + }, + { + "key": "messages", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:ChatMessage" + } + }, + "description": "A list of messages comprising the conversation so far." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The identifier of the model to use.Can be a shared tenancy or custom model identifier." + }, + { + "key": "n", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 1 + } + } + } + }, + { + "key": "octoai", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:ChatCompletionRequestExt" + } + } + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on whether they appear in the generated text so far" + }, + { + "key": "repetition_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "Controls the likelihood of the model generating repeated texts" + }, + { + "key": "response_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:ChatCompletionResponseFormat" + } + } + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Stop" + } + } + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If set, tokens will be streamed incrementally to users." + }, + { + "key": "stream_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:StreamOptions" + } + } + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 2, + "default": 1 + } + } + }, + "description": "Controls the randomness of the sampling." + }, + { + "key": "top_logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 0 + } + } + } + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 1, + "default": 1 + } + } + }, + "description": "Controls the cumulative probability of the top tokens to consider." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:ChatCompletionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:HTTPValidationError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:ErrorResponse" + } + }, + "examples": [ + { + "responseBody": { + "type": "json", + "value": { + "message": "An example error", + "type": "internal_error", + "object": "error" + } + } + } + ] + } + ], + "examples": [ + { + "path": "/v1/chat/completions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "messages": [ + { + "role": "role" + } + ], + "model": "model", + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "choices": [ + { + "index": 1, + "message": { + "role": "role" + }, + "finish_reason": "stop" + } + ], + "created": 1, + "id": "id", + "model": "model", + "usage": { + "completion_tokens": 1, + "prompt_tokens": 1, + "total_tokens": 1 + }, + "object": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"messages\": [\n {\n \"role\": \"role\"\n }\n ],\n \"model\": \"model\",\n \"stream\": false\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.text_gen import (\n ChatCompletionRequestExt,\n ChatCompletionRequestExtVllm,\n ChatCompletionResponseFormat,\n ChatFnCall,\n ChatMessage,\n Function,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_chat_completion_stream(\n frequency_penalty=1.1,\n function_call=\"string\",\n functions=[\n Function(\n description=\"string\",\n name=\"string\",\n parameters={\"key\": \"value\"},\n )\n ],\n ignore_eos=True,\n logit_bias={\"string\": {\"key\": \"value\"}},\n max_tokens=1,\n messages=[\n ChatMessage(\n content=\"string\",\n function_call=ChatFnCall(\n arguments=\"string\",\n name=\"string\",\n ),\n role=\"string\",\n )\n ],\n model=\"string\",\n n=1,\n octoai=ChatCompletionRequestExt(\n vllm=ChatCompletionRequestExtVllm(),\n ),\n presence_penalty=1.1,\n repetition_penalty=1.1,\n response_format=ChatCompletionResponseFormat(\n schema={\"string\": {\"key\": \"value\"}},\n type=\"string\",\n ),\n stop=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createChatCompletion({\n messages: [{\n role: \"role\"\n }],\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/chat/completions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "messages": [ + { + "role": "string" + } + ], + "model": "string", + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"messages\": [\n {\n \"role\": \"string\"\n }\n ],\n \"model\": \"string\",\n \"stream\": false\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.text_gen import (\n ChatCompletionRequestExt,\n ChatCompletionRequestExtVllm,\n ChatCompletionResponseFormat,\n ChatFnCall,\n ChatMessage,\n Function,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_chat_completion_stream(\n frequency_penalty=1.1,\n function_call=\"string\",\n functions=[\n Function(\n description=\"string\",\n name=\"string\",\n parameters={\"key\": \"value\"},\n )\n ],\n ignore_eos=True,\n logit_bias={\"string\": {\"key\": \"value\"}},\n max_tokens=1,\n messages=[\n ChatMessage(\n content=\"string\",\n function_call=ChatFnCall(\n arguments=\"string\",\n name=\"string\",\n ),\n role=\"string\",\n )\n ],\n model=\"string\",\n n=1,\n octoai=ChatCompletionRequestExt(\n vllm=ChatCompletionRequestExtVllm(),\n ),\n presence_penalty=1.1,\n repetition_penalty=1.1,\n response_format=ChatCompletionResponseFormat(\n schema={\"string\": {\"key\": \"value\"}},\n type=\"string\",\n ),\n stop=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createChatCompletion({\n messages: [{\n role: \"role\"\n }],\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/chat/completions", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "messages": [ + { + "role": "string" + } + ], + "model": "string", + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "object": "string", + "code": "string", + "message": "string", + "param": "string", + "type": "string", + "validation_errors": { + "string": "string" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/chat/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"messages\": [\n {\n \"role\": \"string\"\n }\n ],\n \"model\": \"string\",\n \"stream\": false\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\nfrom octoai.text_gen import (\n ChatCompletionRequestExt,\n ChatCompletionRequestExtVllm,\n ChatCompletionResponseFormat,\n ChatFnCall,\n ChatMessage,\n Function,\n)\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_chat_completion_stream(\n frequency_penalty=1.1,\n function_call=\"string\",\n functions=[\n Function(\n description=\"string\",\n name=\"string\",\n parameters={\"key\": \"value\"},\n )\n ],\n ignore_eos=True,\n logit_bias={\"string\": {\"key\": \"value\"}},\n max_tokens=1,\n messages=[\n ChatMessage(\n content=\"string\",\n function_call=ChatFnCall(\n arguments=\"string\",\n name=\"string\",\n ),\n role=\"string\",\n )\n ],\n model=\"string\",\n n=1,\n octoai=ChatCompletionRequestExt(\n vllm=ChatCompletionRequestExtVllm(),\n ),\n presence_penalty=1.1,\n repetition_penalty=1.1,\n response_format=ChatCompletionResponseFormat(\n schema={\"string\": {\"key\": \"value\"}},\n type=\"string\",\n ),\n stop=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createChatCompletion({\n messages: [{\n role: \"role\"\n }],\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.textGen.createChatCompletionStream(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "ignoreEos: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "ignore_eos" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "logitBias: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "logit_bias" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "loglikelihood: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "loglikelihood" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "logprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "messages: [\n\t\t\t$FERN_INPUT\n\t\t]", + "delimiter": ",\n\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "content: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "content" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "role: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": "role" + } + ] + } + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "messages" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "n: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "n" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "octoai: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "vllm: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "bestOf: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.best_of" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "ignoreEos: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.ignore_eos" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "skipSpecialTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.skip_special_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "iterable", + "imports": [], + "isOptional": true, + "containerTemplateString": "stopTokenIds: [\n\t\t\t\t\t$FERN_INPUT\n\t\t\t\t]", + "delimiter": ",\n\t\t\t\t\t", + "innerTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "octoai.vllm.stop_token_ids" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topK: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.top_k" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "useBeamSearch: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "octoai.vllm.use_beam_search" + } + ] + } + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "repetitionPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "repetition_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "responseFormat: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "schema: {\n\t\t\t\t$FERN_INPUT\n\t\t\t}", + "delimiter": ",\n\t\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "response_format.schema" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "type: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "response_format.type" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "streamOptions: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "includeUsage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stream_options.include_usage" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topLogprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "top_logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.text_gen.create_chat_completion_stream(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "frequency_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "frequency_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "functions=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [ + "from octoai.text_gen import Function" + ], + "isOptional": true, + "templateString": "Function(\n\t\t\t$FERN_INPUT\n\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "description=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "description", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "name", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "parameters=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "parameters", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t", + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "functions" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "ignore_eos=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "ignore_eos", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "logit_bias={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "logit_bias" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "max_tokens=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "max_tokens", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "messages=[\n\t\t$FERN_INPUT\n\t]", + "delimiter": ",\n\t\t", + "innerTemplate": { + "imports": [ + "from octoai.text_gen import ChatMessage" + ], + "isOptional": true, + "templateString": "ChatMessage(\n\t\t\t$FERN_INPUT\n\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "content=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "content", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatFnCall" + ], + "isOptional": true, + "templateString": "function_call=ChatFnCall(\n\t\t\t\t$FERN_INPUT\n\t\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "arguments=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "function_call.arguments", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "name=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "function_call.name", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t\t", + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "role=$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": "role", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t", + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "messages" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "model=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "model", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "n=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "n", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatCompletionRequestExt" + ], + "isOptional": true, + "templateString": "octoai=ChatCompletionRequestExt(\n\t\t$FERN_INPUT\n\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatCompletionRequestExtVllm" + ], + "isOptional": true, + "templateString": "vllm=ChatCompletionRequestExtVllm(\n\t\t\t$FERN_INPUT\n\t\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "best_of=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "ignore_eos=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "skip_special_tokens=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "stop_token_ids=[\n\t\t\t\t$FERN_INPUT\n\t\t\t]", + "delimiter": ",\n\t\t\t\t", + "innerTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "templateInput": { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens.vllm.stop_token_ids" + }, + "type": "iterable" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "top_k=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens.vllm.stop_token_ids.vllm.top_k", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "use_beam_search=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "octoai.vllm.best_of.vllm.ignore_eos.vllm.skip_special_tokens.vllm.stop_token_ids.vllm.top_k.vllm.use_beam_search", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t\t", + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t", + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "presence_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "presence_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "repetition_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "repetition_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [ + "from octoai.text_gen import ChatCompletionResponseFormat" + ], + "isOptional": true, + "templateString": "response_format=ChatCompletionResponseFormat(\n\t\t$FERN_INPUT\n\t)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "schema={\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "response_format.schema" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "type=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "response_format.type", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t\t", + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "temperature=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "temperature", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "top_p=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "top_p", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "user=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "user", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_text-gen.createCompletion_stream": { + "id": "endpoint_text-gen.createCompletion_stream", + "namespace": [ + "subpackage_text-gen" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/completions" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://text.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://text.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "best_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "Number of sequences that are generated from the prompt.`best_of` must be greater than or equal to `n`." + }, + { + "key": "echo", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Echo back the prompt in addition to the completion." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on their frequency in the generated text so far." + }, + { + "key": "logit_bias", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + } + }, + { + "key": "loglikelihood", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Switch on loglikelihood regime and return log probabilities from all prompt tokens from prefill." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 5 + } + } + } + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 16 + } + } + }, + "description": "Maximum number of tokens to generate per output sequence." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Model name to use for completion." + }, + { + "key": "n", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 1 + } + } + }, + "description": "Number of output sequences to return." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on whether they appear in the generated text so far" + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Prompt" + } + }, + "description": "The prompt to generate completions from." + }, + { + "key": "repetition_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "Controls the likelihood of the model generating repeated texts" + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 0 + } + } + } + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Stop" + } + }, + "description": "Strings that stop the generation when they are generated." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": true + } + }, + "description": "If set, tokens will be streamed incrementally to users." + }, + { + "key": "stream_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:StreamOptions" + } + } + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 2, + "default": 1 + } + } + }, + "description": "Controls the randomness of the sampling." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 1, + "default": 1 + } + } + }, + "description": "Controls the cumulative probability of the top tokens to consider." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "stream", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:CompletionResponse" + } + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:HTTPValidationError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:ErrorResponse" + } + }, + "examples": [ + { + "responseBody": { + "type": "json", + "value": { + "message": "An example error", + "type": "internal_error", + "object": "error" + } + } + } + ] + } + ], + "examples": [ + { + "path": "/v1/completions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string", + "stream": true + } + }, + "responseBody": { + "type": "stream", + "value": [ + { + "choices": [ + { + "finish_reason": "stop", + "index": 0, + "logprobs": { + "content": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string", + "top_logprobs": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string" + } + ] + } + ] + }, + "text": "string" + } + ], + "created": 0, + "id": "string", + "model": "string", + "object": {}, + "system_fingerprint": "string", + "usage": { + "completion_tokens": 0, + "prompt_tokens": 0, + "total_tokens": 0 + } + }, + { + "choices": [ + { + "finish_reason": "stop", + "index": 0, + "logprobs": { + "content": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string", + "top_logprobs": [ + { + "bytes": [ + {} + ], + "logprob": 1, + "token": "string" + } + ] + } + ] + }, + "text": "string" + } + ], + "created": 0, + "id": "string", + "model": "string", + "object": {}, + "system_fingerprint": "string", + "usage": { + "completion_tokens": 0, + "prompt_tokens": 0, + "total_tokens": 0 + } + } + ] + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\",\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_completion_stream(\n best_of=1,\n echo=True,\n frequency_penalty=1.1,\n logit_bias={\"string\": {\"key\": \"value\"}},\n logprobs=1,\n max_tokens=1,\n model=\"string\",\n n=1,\n presence_penalty=1.1,\n prompt=\"string\",\n repetition_penalty=1.1,\n seed=1,\n stop=\"string\",\n suffix=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createCompletion({\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/completions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string", + "stream": true + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\",\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_completion_stream(\n best_of=1,\n echo=True,\n frequency_penalty=1.1,\n logit_bias={\"string\": {\"key\": \"value\"}},\n logprobs=1,\n max_tokens=1,\n model=\"string\",\n n=1,\n presence_penalty=1.1,\n prompt=\"string\",\n repetition_penalty=1.1,\n seed=1,\n stop=\"string\",\n suffix=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createCompletion({\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/completions", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string", + "stream": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": "string", + "message": "string", + "object": "string", + "param": "string", + "type": "string", + "validation_errors": { + "string": "string" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\",\n \"stream\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_completion_stream(\n best_of=1,\n echo=True,\n frequency_penalty=1.1,\n logit_bias={\"string\": {\"key\": \"value\"}},\n logprobs=1,\n max_tokens=1,\n model=\"string\",\n n=1,\n presence_penalty=1.1,\n prompt=\"string\",\n repetition_penalty=1.1,\n seed=1,\n stop=\"string\",\n suffix=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createCompletion({\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.textGen.createCompletionStream(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "bestOf: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "best_of" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "echo: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "echo" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "logitBias: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "logit_bias" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "loglikelihood: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "loglikelihood" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "logprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "n: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "n" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "repetitionPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "repetition_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "streamOptions: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "includeUsage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stream_options.include_usage" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "suffix: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "suffix" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.text_gen.create_completion_stream(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "best_of=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "best_of", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "echo=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "echo", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "frequency_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "frequency_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "logit_bias={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "logit_bias" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "logprobs=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "logprobs", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "max_tokens=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "max_tokens", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "model=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "model", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "n=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "n", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "presence_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "presence_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "repetition_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "repetition_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "seed=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "seed", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "suffix=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "suffix", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "temperature=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "temperature", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "top_p=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "top_p", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "user=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "user", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + }, + "endpoint_text-gen.createCompletion": { + "id": "endpoint_text-gen.createCompletion", + "namespace": [ + "subpackage_text-gen" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/v1/completions" + } + ], + "defaultEnvironment": "Production", + "environments": [ + { + "id": "Production", + "baseUrl": "https://text.octoai.run" + }, + { + "id": "SecureLink", + "baseUrl": "https://text.securelink.octo.ai" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "best_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + }, + "description": "Number of sequences that are generated from the prompt.`best_of` must be greater than or equal to `n`." + }, + { + "key": "echo", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Echo back the prompt in addition to the completion." + }, + { + "key": "frequency_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on their frequency in the generated text so far." + }, + { + "key": "logit_bias", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + } + }, + { + "key": "loglikelihood", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Switch on loglikelihood regime and return log probabilities from all prompt tokens from prefill." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 0, + "maximum": 5 + } + } + } + }, + { + "key": "max_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 16 + } + } + }, + "description": "Maximum number of tokens to generate per output sequence." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Model name to use for completion." + }, + { + "key": "n", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "default": 1 + } + } + }, + "description": "Number of output sequences to return." + }, + { + "key": "presence_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": -2, + "maximum": 2, + "default": 0 + } + } + }, + "description": "Penalizes new tokens based on whether they appear in the generated text so far" + }, + { + "key": "prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Prompt" + } + }, + "description": "The prompt to generate completions from." + }, + { + "key": "repetition_penalty", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "default": 1 + } + } + }, + "description": "Controls the likelihood of the model generating repeated texts" + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 0 + } + } + } + }, + { + "key": "stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Stop" + } + }, + "description": "Strings that stop the generation when they are generated." + }, + { + "key": "stream", + "valueShape": { + "type": "literal", + "value": { + "type": "booleanLiteral", + "value": false + } + }, + "description": "If set, tokens will be streamed incrementally to users." + }, + { + "key": "stream_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:StreamOptions" + } + } + }, + { + "key": "suffix", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "temperature", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 2, + "default": 1 + } + } + }, + "description": "Controls the randomness of the sampling." + }, + { + "key": "top_p", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 1, + "default": 1 + } + } + }, + "description": "Controls the cumulative probability of the top tokens to consider." + }, + { + "key": "user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:CompletionResponse" + } + } + }, + "errors": [ + { + "description": "Validation Error", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:HTTPValidationError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_text-gen:ErrorResponse" + } + }, + "examples": [ + { + "responseBody": { + "type": "json", + "value": { + "message": "An example error", + "type": "internal_error", + "object": "error" + } + } + } + ] + } + ], + "examples": [ + { + "path": "/v1/completions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "model", + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "choices": [ + { + "index": 1, + "text": "text", + "finish_reason": "stop" + } + ], + "created": 1, + "id": "id", + "model": "model", + "system_fingerprint": "system_fingerprint", + "object": { + "key": "value" + }, + "usage": { + "completion_tokens": 1, + "prompt_tokens": 1, + "total_tokens": 1 + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"model\",\n \"stream\": false\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_completion_stream(\n best_of=1,\n echo=True,\n frequency_penalty=1.1,\n logit_bias={\"string\": {\"key\": \"value\"}},\n logprobs=1,\n max_tokens=1,\n model=\"string\",\n n=1,\n presence_penalty=1.1,\n prompt=\"string\",\n repetition_penalty=1.1,\n seed=1,\n stop=\"string\",\n suffix=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createCompletion({\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/completions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string", + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "detail": [ + { + "loc": [ + "string" + ], + "msg": "string", + "type": "string" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\",\n \"stream\": false\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_completion_stream(\n best_of=1,\n echo=True,\n frequency_penalty=1.1,\n logit_bias={\"string\": {\"key\": \"value\"}},\n logprobs=1,\n max_tokens=1,\n model=\"string\",\n n=1,\n presence_penalty=1.1,\n prompt=\"string\",\n repetition_penalty=1.1,\n seed=1,\n stop=\"string\",\n suffix=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createCompletion({\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/v1/completions", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "model": "string", + "stream": false + } + }, + "responseBody": { + "type": "json", + "value": { + "object": "string", + "code": "string", + "message": "string", + "param": "string", + "type": "string", + "validation_errors": { + "string": "string" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://text.octoai.run/v1/completions \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"string\",\n \"stream\": false\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)\nclient.text_gen.create_completion_stream(\n best_of=1,\n echo=True,\n frequency_penalty=1.1,\n logit_bias={\"string\": {\"key\": \"value\"}},\n logprobs=1,\n max_tokens=1,\n model=\"string\",\n n=1,\n presence_penalty=1.1,\n prompt=\"string\",\n repetition_penalty=1.1,\n seed=1,\n stop=\"string\",\n suffix=\"string\",\n temperature=1.1,\n top_p=1.1,\n user=\"string\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { OctoAIClient } from \"@octoai/sdk\";\n\nconst octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\nawait octoAi.textGen.createCompletion({\n model: \"model\",\n stream: false\n});\n", + "generated": true + } + ] + } + } + ], + "snippetTemplates": { + "typescript": { + "type": "v1", + "functionInvocation": { + "type": "generic", + "imports": [], + "templateString": "await octoAi.textGen.createCompletionStream(\n\t$FERN_INPUT\n)", + "isOptional": false, + "inputDelimiter": ",\n\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "{\n\t\t$FERN_INPUT\n\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "bestOf: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "best_of" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "echo: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "echo" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "frequencyPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "frequency_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "dict", + "imports": [], + "isOptional": true, + "containerTemplateString": "logitBias: {\n\t\t\t$FERN_INPUT\n\t\t}", + "delimiter": ",\n\t\t\t", + "keyValueSeparator": ": ", + "keyTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "valueTemplate": { + "type": "generic", + "imports": [], + "templateString": "$FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "RELATIVE", + "path": null + } + ] + }, + "templateInput": { + "location": "BODY", + "path": "logit_bias" + } + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "loglikelihood: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "loglikelihood" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "logprobs: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "logprobs" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "maxTokens: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "max_tokens" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "model: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "model" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "n: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "n" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "presencePenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "presence_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "repetitionPenalty: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "repetition_penalty" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "seed: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "seed" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "streamOptions: {\n\t\t\t$FERN_INPUT\n\t\t}", + "isOptional": true, + "inputDelimiter": ",\n\t\t\t", + "templateInputs": [ + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "includeUsage: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "stream_options.include_usage" + } + ] + } + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "suffix: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "suffix" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "temperature: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "temperature" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "topP: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "top_p" + } + ] + } + }, + { + "type": "template", + "value": { + "type": "generic", + "imports": [], + "templateString": "user: $FERN_INPUT", + "isOptional": true, + "templateInputs": [ + { + "type": "payload", + "location": "BODY", + "path": "user" + } + ] + } + } + ] + } + } + ] + }, + "clientInstantiation": "const octoAi = new OctoAIClient({ apiKey: \"YOUR_API_KEY\" });\n" + }, + "python": { + "type": "v1", + "functionInvocation": { + "imports": [], + "isOptional": true, + "templateString": "client.text_gen.create_completion_stream(\n\t$FERN_INPUT\n)", + "templateInputs": [ + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "best_of=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "best_of", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "echo=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "echo", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "frequency_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "frequency_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "containerTemplateString": "logit_bias={\n\t\t$FERN_INPUT\n\t}", + "delimiter": ",\n\t\t", + "keyTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "valueTemplate": { + "imports": [], + "isOptional": true, + "templateString": "$FERN_INPUT", + "templateInputs": [ + { + "location": "RELATIVE", + "path": null, + "type": "payload" + } + ], + "type": "generic" + }, + "keyValueSeparator": ": ", + "templateInput": { + "location": "BODY", + "path": "logit_bias" + }, + "type": "dict" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "logprobs=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "logprobs", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "max_tokens=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "max_tokens", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "model=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "model", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "n=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "n", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "presence_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "presence_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "repetition_penalty=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "repetition_penalty", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "seed=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "seed", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "suffix=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "suffix", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "temperature=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "temperature", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "top_p=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "top_p", + "type": "payload" + } + ], + "type": "generic" + } + }, + { + "type": "template", + "value": { + "imports": [], + "isOptional": true, + "templateString": "user=$FERN_INPUT", + "templateInputs": [ + { + "location": "BODY", + "path": "user", + "type": "payload" + } + ], + "type": "generic" + } + } + ], + "inputDelimiter": ",\n\t", + "type": "generic" + }, + "clientInstantiation": "from octoai.client import OctoAI\n\nclient = OctoAI(\n api_key=\"YOUR_API_KEY\",\n)" + } + } + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_asset-library:Data": { + "name": "Data", + "description": "Asset data.", + "shape": { + "type": "discriminatedUnion", + "discriminant": "asset_type", + "variants": [ + { + "discriminantValue": "checkpoint", + "extends": [ + "type_asset-library:CheckpointData" + ], + "properties": [] + }, + { + "discriminantValue": "file", + "extends": [ + "type_asset-library:FileData" + ], + "properties": [] + }, + { + "discriminantValue": "latent", + "extends": [ + "type_asset-library:LatentData" + ], + "properties": [] + }, + { + "discriminantValue": "lora", + "extends": [ + "type_asset-library:LoraData" + ], + "properties": [] + }, + { + "discriminantValue": "textual_inversion", + "extends": [ + "type_asset-library:TextualInversionData" + ], + "properties": [] + }, + { + "discriminantValue": "vae", + "extends": [ + "type_asset-library:VAEData" + ], + "properties": [] + } + ] + } + }, + "type_asset-library:Asset": { + "name": "Asset", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "asset_type", + "valueShape": { + "type": "id", + "id": "type_asset-library:AssetType" + }, + "description": "Asset type." + }, + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset creation time." + }, + { + "key": "data", + "valueShape": { + "type": "id", + "id": "type_asset-library:Data" + }, + "description": "Asset data." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Description." + }, + { + "key": "file_structure", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:FileStructure" + } + }, + "description": "File structure." + }, + { + "key": "hf_repo", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset id." + }, + { + "key": "is_public", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "True if asset is public." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset name." + }, + { + "key": "size_bytes", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Size in bytes." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_asset-library:Status" + }, + "description": "Asset status." + }, + { + "key": "status_details", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset status." + }, + { + "key": "status_info", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Asset status info." + }, + { + "key": "tenant_uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset tenant ID." + }, + { + "key": "url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1 + } + } + } + } + ] + } + }, + "type_asset-library:AssetType": { + "name": "AssetType", + "shape": { + "type": "enum", + "values": [ + { + "value": "file" + }, + { + "value": "checkpoint" + }, + { + "value": "lora" + }, + { + "value": "textual_inversion" + }, + { + "value": "vae" + }, + { + "value": "latent" + } + ] + } + }, + "type_asset-library:BaseEngine": { + "name": "BaseEngine", + "shape": { + "type": "enum", + "values": [ + { + "value": "text/llama-2-7b" + }, + { + "value": "text/llama-2-13b" + }, + { + "value": "text/llama-2-70b" + }, + { + "value": "text/codellama-7b" + }, + { + "value": "text/codellama-13b" + }, + { + "value": "text/codellama-34b" + }, + { + "value": "text/codellama-70b" + }, + { + "value": "text/mistral-7b" + }, + { + "value": "text/mixtral-8x7b" + }, + { + "value": "image/controlnet-sd15" + }, + { + "value": "image/controlnet-sdxl" + }, + { + "value": "image/stable-diffusion-v1-5" + }, + { + "value": "image/stable-diffusion-xl-v1-0" + }, + { + "value": "image/stable-diffusion-ssd" + }, + { + "value": "audio/tortoise-tts" + }, + { + "value": "audio/rvc" + } + ] + } + }, + "type_asset-library:BaseEngineType": { + "name": "BaseEngineType", + "shape": { + "type": "enum", + "values": [ + { + "value": "text" + }, + { + "value": "image" + }, + { + "value": "audio" + } + ] + } + }, + "type_asset-library:CheckpointData": { + "name": "CheckpointData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:DataType" + } + }, + "description": "Data type." + }, + { + "key": "engine", + "valueShape": { + "type": "id", + "id": "type_asset-library:BaseEngine" + }, + "description": "Engine type." + }, + { + "key": "file_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:FileFormat" + } + }, + "description": "File format." + } + ] + } + }, + "type_asset-library:CompleteAssetUploadResponse": { + "name": "CompleteAssetUploadResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_asset-library:CreateAssetResponseTransferApi": { + "name": "CreateAssetResponseTransferApi", + "description": "Asset transfer API.", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "none", + "extends": [ + "type_asset-library:NoTransferApi" + ], + "properties": [] + }, + { + "discriminantValue": "presigned-url", + "extends": [ + "type_asset-library:PresignedUrlTransferApi" + ], + "properties": [] + }, + { + "discriminantValue": "sts", + "extends": [ + "type_asset-library:StsTransferApi" + ], + "properties": [] + } + ] + } + }, + "type_asset-library:CreateAssetResponse": { + "name": "CreateAssetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "asset", + "valueShape": { + "type": "id", + "id": "type_asset-library:Asset" + }, + "description": "Asset." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "" + } + } + }, + "description": "Unused. Present for compatibility purposes." + }, + { + "key": "transfer_api", + "valueShape": { + "type": "id", + "id": "type_asset-library:CreateAssetResponseTransferApi" + }, + "description": "Asset transfer API." + } + ] + } + }, + "type_asset-library:DataType": { + "name": "DataType", + "shape": { + "type": "enum", + "values": [ + { + "value": "fp16" + }, + { + "value": "fp32" + }, + { + "value": "int4" + }, + { + "value": "int8" + } + ] + } + }, + "type_asset-library:DeleteAssetResponse": { + "name": "DeleteAssetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deleted_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Deletion time." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset ID." + } + ] + } + }, + "type_asset-library:FileData": { + "name": "FileData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:FileExtension" + } + }, + "description": "File format." + }, + { + "key": "preview_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "" + } + } + }, + "description": "Version." + } + ] + } + }, + "type_asset-library:FileExtension": { + "name": "FileExtension", + "shape": { + "type": "enum", + "values": [ + { + "value": "unknown" + }, + { + "value": "png" + }, + { + "value": "jpg" + }, + { + "value": "jpeg" + }, + { + "value": "txt" + }, + { + "value": "mp3" + }, + { + "value": "wav" + } + ] + } + }, + "type_asset-library:FileFormat": { + "name": "FileFormat", + "shape": { + "type": "enum", + "values": [ + { + "value": "safetensors" + }, + { + "value": "pt" + } + ] + } + }, + "type_asset-library:FileStructure": { + "name": "FileStructure", + "shape": { + "type": "enum", + "values": [ + { + "value": "unknown" + }, + { + "value": "single_file" + }, + { + "value": "multiple_files" + } + ] + } + }, + "type_asset-library:HTTPValidationError": { + "name": "HTTPValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_asset-library:ValidationError" + } + } + } + } + ] + } + }, + "type_asset-library:LatentData": { + "name": "LatentData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "engine", + "valueShape": { + "type": "id", + "id": "type_asset-library:BaseEngine" + }, + "description": "Engine type." + }, + { + "key": "file_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:FileFormat" + } + }, + "description": "File format." + } + ] + } + }, + "type_asset-library:ListAssetsResponse": { + "name": "ListAssetsResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_asset-library:Asset" + } + }, + "description": "List of assets." + }, + { + "key": "has_more", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if there are more asset to show." + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Total number of assets." + } + ] + } + }, + "type_asset-library:LoraData": { + "name": "LoraData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "checkpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "data_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:DataType" + } + }, + "description": "Data type." + }, + { + "key": "engine", + "valueShape": { + "type": "id", + "id": "type_asset-library:BaseEngine" + }, + "description": "Engine type." + }, + { + "key": "file_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:FileFormat" + } + }, + "description": "File format." + }, + { + "key": "trigger_words", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_asset-library:NoTransferApi": { + "name": "NoTransferApi", + "description": "This type exists to avoid Optional[TransferApi] so openapi-generator can work.\n\nIn this class, type is not added to TransferApiType because it is not a valid\nTransferApiType. It exists only to note that no TransferApi is defined.", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + }, + "type_asset-library:PresignedUrlTransferApi": { + "name": "PresignedUrlTransferApi", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "get_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Get asset URL." + }, + { + "key": "put_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Asset URL to upload." + } + ] + } + }, + "type_asset-library:RetrieveAssetResponseTransferApi": { + "name": "RetrieveAssetResponseTransferApi", + "description": "Transfer API.", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "none", + "extends": [ + "type_asset-library:NoTransferApi" + ], + "properties": [] + }, + { + "discriminantValue": "presigned-url", + "extends": [ + "type_asset-library:PresignedUrlTransferApi" + ], + "properties": [] + }, + { + "discriminantValue": "sts", + "extends": [ + "type_asset-library:StsTransferApi" + ], + "properties": [] + } + ] + } + }, + "type_asset-library:RetrieveAssetResponse": { + "name": "RetrieveAssetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "asset", + "valueShape": { + "type": "id", + "id": "type_asset-library:Asset" + }, + "description": "Asset." + }, + { + "key": "transfer_api", + "valueShape": { + "type": "id", + "id": "type_asset-library:RetrieveAssetResponseTransferApi" + }, + "description": "Transfer API." + } + ] + } + }, + "type_asset-library:Status": { + "name": "Status", + "shape": { + "type": "enum", + "values": [ + { + "value": "ready_to_upload" + }, + { + "value": "uploaded" + }, + { + "value": "ready" + }, + { + "value": "deleted" + }, + { + "value": "rejected" + }, + { + "value": "error" + }, + { + "value": "uploading" + } + ] + } + }, + "type_asset-library:StsTransferApi": { + "name": "StsTransferApi", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "aws_access_key_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "AWS access key." + }, + { + "key": "aws_secret_access_key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "AWS secret accesss key." + }, + { + "key": "aws_session_token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "s3_bucket", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "S3 bucket." + }, + { + "key": "s3_endpoint_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "s3_key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "S3 key." + }, + { + "key": "s3_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "S3 full URL." + } + ] + } + }, + "type_asset-library:TextualInversionData": { + "name": "TextualInversionData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:DataType" + } + }, + "description": "Data type." + }, + { + "key": "engine", + "valueShape": { + "type": "id", + "id": "type_asset-library:BaseEngine" + }, + "description": "Engine type." + }, + { + "key": "file_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:FileFormat" + } + }, + "description": "File format." + }, + { + "key": "trigger_words", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Trigger words." + } + ] + } + }, + "type_asset-library:TransferApiType": { + "name": "TransferApiType", + "shape": { + "type": "enum", + "values": [ + { + "value": "presigned-url" + }, + { + "value": "sts" + } + ] + } + }, + "type_asset-library:VAEData": { + "name": "VAEData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:DataType" + } + }, + "description": "Data type." + }, + { + "key": "engine", + "valueShape": { + "type": "id", + "id": "type_asset-library:BaseEngine" + }, + "description": "Engine type." + }, + { + "key": "file_format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_asset-library:FileFormat" + } + }, + "description": "File format." + } + ] + } + }, + "type_asset-library:ValidationErrorLocItem": { + "name": "ValidationErrorLocItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_asset-library:ValidationError": { + "name": "ValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "loc", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_asset-library:ValidationErrorLocItem" + } + } + }, + { + "key": "msg", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_fine-tuning:Details": { + "name": "Details", + "description": "Details of the tune.", + "shape": { + "type": "discriminatedUnion", + "discriminant": "tune_type", + "variants": [ + { + "discriminantValue": "lora_tune", + "extends": [ + "type_fine-tuning:LoraTune" + ], + "properties": [] + }, + { + "discriminantValue": "text_to_speech_latent_tune", + "extends": [ + "type_fine-tuning:TextToSpeechLatentTune" + ], + "properties": [] + } + ] + } + }, + "type_fine-tuning:BaseEngine": { + "name": "BaseEngine", + "description": "BaseEngine", + "shape": { + "type": "enum", + "values": [ + { + "value": "text/llama-2-7b" + }, + { + "value": "text/llama-2-13b" + }, + { + "value": "text/llama-2-70b" + }, + { + "value": "text/codellama-7b" + }, + { + "value": "text/codellama-13b" + }, + { + "value": "text/codellama-34b" + }, + { + "value": "text/codellama-70b" + }, + { + "value": "text/mistral-7b" + }, + { + "value": "text/mixtral-8x7b" + }, + { + "value": "image/controlnet-sd15" + }, + { + "value": "image/controlnet-sdxl" + }, + { + "value": "image/stable-diffusion-v1-5" + }, + { + "value": "image/stable-diffusion-xl-v1-0" + }, + { + "value": "image/stable-diffusion-ssd" + }, + { + "value": "audio/tortoise-tts" + }, + { + "value": "audio/rvc" + } + ] + } + }, + "type_fine-tuning:HTTPValidationError": { + "name": "HTTPValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_fine-tuning:ValidationError" + } + } + } + } + ] + } + }, + "type_fine-tuning:ListTunesResponse": { + "name": "ListTunesResponse", + "description": "The list tunes response.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_fine-tuning:Tune" + } + }, + "description": "List of tunes." + }, + { + "key": "has_more", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if it has more items than the returned list." + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Total number of tunes." + } + ] + } + }, + "type_fine-tuning:LoraTune": { + "name": "LoraTune", + "description": "A LoRA Tune.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "base_checkpoint", + "valueShape": { + "type": "id", + "id": "type_fine-tuning:LoraTuneCheckpoint" + }, + "description": "The base checkpoint used for this LoRA Tune." + }, + { + "key": "files", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_fine-tuning:LoraTuneFile" + } + }, + "description": "The files used for this LoRA Tune." + }, + { + "key": "resize_images", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "steps", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of steps used for this LoRA Tune." + }, + { + "key": "trigger_words", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The trigger words used for this tune. As of now, only one trigger word is supported. `List` is used for future-proofing." + } + ] + } + }, + "type_fine-tuning:LoraTuneCheckpoint": { + "name": "LoraTuneCheckpoint", + "description": "A checkpoint used for a LoRA Tune.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "checkpoint_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The checkpoint asset ID." + }, + { + "key": "engine", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_fine-tuning:BaseEngine" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_fine-tuning:LoraTuneFile": { + "name": "LoraTuneFile", + "description": "An input file to a LoRA tune with its caption.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "caption", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "file_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the file on asset lake." + } + ] + } + }, + "type_fine-tuning:TextToSpeechLatentTune": { + "name": "TextToSpeechLatentTune", + "description": "A TextToSpeechLatentTune.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "asset_ids", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Asset Lake asset ids used for this task." + }, + { + "key": "inline_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_fine-tuning:TuneDetails": { + "name": "TuneDetails", + "description": "Tune details.", + "shape": { + "type": "discriminatedUnion", + "discriminant": "tune_type", + "variants": [ + { + "discriminantValue": "lora_tune", + "extends": [ + "type_fine-tuning:LoraTune" + ], + "properties": [] + }, + { + "discriminantValue": "text_to_speech_latent_tune", + "extends": [ + "type_fine-tuning:TextToSpeechLatentTune" + ], + "properties": [] + } + ] + } + }, + "type_fine-tuning:Tune": { + "name": "Tune", + "description": "A tune base class.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time this tune task was created." + }, + { + "key": "deleted_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The description of the tune." + }, + { + "key": "details", + "valueShape": { + "type": "id", + "id": "type_fine-tuning:TuneDetails" + }, + "description": "Tune details." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID of the LoRA tune." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the tune." + }, + { + "key": "output_lora_ids", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The output LoRA IDs, if the task was successful." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_fine-tuning:TuneResult" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_fine-tuning:TuneStatus" + }, + "description": "The status of the associated task." + }, + { + "key": "status_details", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The details of the status, only used when the associated task failed." + }, + { + "key": "succeeded_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "tenant_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The tenant who requested the LoRA tune." + }, + { + "key": "tune_type", + "valueShape": { + "type": "id", + "id": "type_fine-tuning:TuneType" + }, + "description": "The type of this tune." + }, + { + "key": "updated_at", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The time this tune task was updated." + } + ] + } + }, + "type_fine-tuning:TuneResult": { + "name": "TuneResult", + "description": "Tune result on worker.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "number_of_available_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "output_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "rejected_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "unready_assets", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_fine-tuning:TuneStatus": { + "name": "TuneStatus", + "description": "The status of the tune job.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "running" + }, + { + "value": "succeeded" + }, + { + "value": "cancelled" + }, + { + "value": "failed" + } + ] + } + }, + "type_fine-tuning:TuneType": { + "name": "TuneType", + "description": "The type of tune requested.", + "shape": { + "type": "enum", + "values": [ + { + "value": "lora_tune" + }, + { + "value": "text_to_speech_latent_tune" + }, + { + "value": "text_to_speech_rvc_tune" + }, + { + "value": "text_to_speech_tortoise_tune" + } + ] + } + }, + "type_fine-tuning:ValidationErrorLocItem": { + "name": "ValidationErrorLocItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_fine-tuning:ValidationError": { + "name": "ValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "loc", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_fine-tuning:ValidationErrorLocItem" + } + } + }, + { + "key": "msg", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_image-gen:VideoGenerationRequestSeed": { + "name": "VideoGenerationRequestSeed", + "description": "Integer number or list of integers representing the seeds of random generators.Fixing random seed is useful when attempting to generate a specific video/animation (or set of videos/animations). Must be greater than 0 and less than 2^32.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + ] + } + }, + "type_image-gen:HTTPValidationError": { + "name": "HTTPValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_image-gen:ValidationError" + } + } + } + } + ] + } + }, + "type_image-gen:ImageEncoding": { + "name": "ImageEncoding", + "description": "The image encoding types available for image generation response.", + "shape": { + "type": "enum", + "values": [ + { + "value": "jpeg" + }, + { + "value": "png" + } + ] + } + }, + "type_image-gen:ImageGeneration": { + "name": "ImageGeneration", + "description": "Represent a generated image.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "image_b64", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "removed_for_safety", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if the image was removed for safety, False otherwise." + }, + { + "key": "seed", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Seed used to generate the image. It can be used to recreate the generation." + }, + { + "key": "safety_score", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "type_image-gen:ImageGenerationRequestSeed": { + "name": "ImageGenerationRequestSeed", + "description": "Integer number or list of integers representing the seeds of random generators. Fixing random seed is useful when attempting to generate a specific image. Must be greater than 0 and less than 2^32.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + ] + } + }, + "type_image-gen:ImageGenerationRequest": { + "name": "ImageGenerationRequest", + "description": "Generate one or more images based on the given parameters.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "prompt", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Text describing the image content to generate." + }, + { + "key": "prompt_2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "negative_prompt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "negative_prompt_2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "checkpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "controlnet", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "vae", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "textual_inversions", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + }, + { + "key": "loras", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + } + }, + { + "key": "sampler", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_image-gen:Scheduler" + } + }, + "description": "Sampler name (also known as 'scheduler') to use during image generation." + }, + { + "key": "height", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "width", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "cfg_scale", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "maximum": 50, + "default": 12 + } + } + }, + "description": "Floating-point number represeting how closely to adhere to prompt description. Must be a positive number no greater than 50.0." + }, + { + "key": "steps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "maximum": 200, + "default": 30 + } + } + }, + "description": "Integer repreenting how many steps of diffusion to run. Must be greater than 0 and less than or equal to 200." + }, + { + "key": "num_images", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "maximum": 16, + "default": 1 + } + } + }, + "description": "Integer representing how many output images to generate with a single prompt/configuration." + }, + { + "key": "seed", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_image-gen:ImageGenerationRequestSeed" + } + }, + "description": "Integer number or list of integers representing the seeds of random generators. Fixing random seed is useful when attempting to generate a specific image. Must be greater than 0 and less than 2^32." + }, + { + "key": "controlnet_image", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "init_image", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mask_image", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "strength", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1, + "default": 0.8 + } + } + }, + "description": "Floating-point number indicating how much creative the Image to Image generation mode should be. Must be greater than 0 and less than or equal to 1.0." + }, + { + "key": "style_preset", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_image-gen:SDXLStyles" + } + } + }, + { + "key": "use_refiner", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to enable and apply the SDXL refiner model to the image generation." + }, + { + "key": "high_noise_frac", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1, + "default": 0.8 + } + } + }, + "description": "Floating-point number that defines the fraction of steps to perform with the base model. Used only by SD XL. Must be greater than or equal to 0.0 and less than or equal to 1.0." + }, + { + "key": "controlnet_conditioning_scale", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "default": 1 + } + } + }, + "description": "How strong the effect of the controlnet should be." + }, + { + "key": "controlnet_early_stop", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 0, + "maximum": 1 + } + } + } + }, + { + "key": "controlnet_preprocess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to apply automatic ControlNet preprocessing." + }, + { + "key": "clip_skip", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1, + "maximum": 12 + } + } + } + }, + { + "key": "outpainting", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the request requires outpainting or not. If so, special preprocessing is applied for better results." + }, + { + "key": "enable_safety", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Boolean defining whether to use safety checker system on generated outputs or not." + }, + { + "key": "image_encoding", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_image-gen:ImageEncoding" + } + }, + "description": "Define which encoding process should be applied before returning the generated image(s)." + }, + { + "key": "transfer_images", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + { + "key": "force_asset_download", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "[Internal] Boolean defining if assets must be re-downloaded into the cache even if present." + }, + { + "key": "force_asset_gpu_copy", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "[Internal] Boolean defining if assets must to be copied into the GPU even if present." + } + ] + } + }, + "type_image-gen:ImageGenerationResponse": { + "name": "ImageGenerationResponse", + "description": "Response to an ImageGenerationRequest.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "images", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_image-gen:ImageGeneration" + } + }, + "description": "List of ImageGeneration(s) generated by the request." + }, + { + "key": "prediction_time_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Total runtime of the image generation(s)." + } + ] + } + }, + "type_image-gen:SDXLStyles": { + "name": "SDXLStyles", + "description": "The supported SDXL styles.", + "shape": { + "type": "enum", + "values": [ + { + "value": "base" + }, + { + "value": "3d-model" + }, + { + "value": "analog-film" + }, + { + "value": "anime" + }, + { + "value": "cinematic" + }, + { + "value": "comic-book" + }, + { + "value": "Craft Clay" + }, + { + "value": "modeling-compound" + }, + { + "value": "digital-art" + }, + { + "value": "enhance" + }, + { + "value": "fantasy-art" + }, + { + "value": "isometric" + }, + { + "value": "line-art" + }, + { + "value": "low-poly" + }, + { + "value": "neon-punk" + }, + { + "value": "origami" + }, + { + "value": "photographic" + }, + { + "value": "pixel-art" + }, + { + "value": "tile-texture" + }, + { + "value": "Advertising" + }, + { + "value": "Food Photography" + }, + { + "value": "Real Estate" + }, + { + "value": "Abstract" + }, + { + "value": "Cubist" + }, + { + "value": "Graffiti" + }, + { + "value": "Hyperrealism" + }, + { + "value": "Impressionist" + }, + { + "value": "Pointillism" + }, + { + "value": "Pop Art" + }, + { + "value": "Psychedelic" + }, + { + "value": "Renaissance" + }, + { + "value": "Steampunk" + }, + { + "value": "Surrealist" + }, + { + "value": "Typography" + }, + { + "value": "Watercolor" + }, + { + "value": "Fighting Game" + }, + { + "value": "GTA" + }, + { + "value": "Super Mario" + }, + { + "value": "Minecraft" + }, + { + "value": "Pokémon" + }, + { + "value": "Retro Arcade" + }, + { + "value": "Retro Game" + }, + { + "value": "RPG Fantasy Game" + }, + { + "value": "Strategy Game" + }, + { + "value": "Street Fighter" + }, + { + "value": "Legend of Zelda" + }, + { + "value": "Architectural" + }, + { + "value": "Disco" + }, + { + "value": "Dreamscape" + }, + { + "value": "Dystopian" + }, + { + "value": "Fairy Tale" + }, + { + "value": "Gothic" + }, + { + "value": "Grunge" + }, + { + "value": "Horror" + }, + { + "value": "Minimalist" + }, + { + "value": "Monochrome" + }, + { + "value": "Nautical" + }, + { + "value": "Space" + }, + { + "value": "Stained Glass" + }, + { + "value": "Techwear Fashion" + }, + { + "value": "Tribal" + }, + { + "value": "Zentangle" + }, + { + "value": "Collage" + }, + { + "value": "Flat Papercut" + }, + { + "value": "Kirigami" + }, + { + "value": "Paper Mache" + }, + { + "value": "Paper Quilling" + }, + { + "value": "Papercut Collage" + }, + { + "value": "Papercut Shadow Box" + }, + { + "value": "Stacked Papercut" + }, + { + "value": "Thick Layered Papercut" + }, + { + "value": "Alien" + }, + { + "value": "Film Noir" + }, + { + "value": "HDR" + }, + { + "value": "Long Exposure" + }, + { + "value": "Neon Noir" + }, + { + "value": "Silhouette" + }, + { + "value": "Tilt-Shift" + } + ] + } + }, + "type_image-gen:Scheduler": { + "name": "Scheduler", + "description": "The schedulers available for image generation.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PNDM" + }, + { + "value": "LMS" + }, + { + "value": "KLMS" + }, + { + "value": "DDIM" + }, + { + "value": "DDPM" + }, + { + "value": "HEUN" + }, + { + "value": "K_HEUN" + }, + { + "value": "K_EULER" + }, + { + "value": "K_EULER_ANCESTRAL" + }, + { + "value": "DPM_SOLVER_MULTISTEP" + }, + { + "value": "DPM_PLUS_PLUS_2M_KARRAS" + }, + { + "value": "DPM_SINGLE" + }, + { + "value": "DPM_2" + }, + { + "value": "DPM_2_ANCESTRAL" + }, + { + "value": "DPM_PLUS_PLUS_SDE_KARRAS" + }, + { + "value": "UNI_PC" + }, + { + "value": "LCM" + } + ] + } + }, + "type_image-gen:ValidationErrorLocItem": { + "name": "ValidationErrorLocItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_image-gen:ValidationError": { + "name": "ValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "loc", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_image-gen:ValidationErrorLocItem" + } + } + }, + { + "key": "msg", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_image-gen:VideoGeneration": { + "name": "VideoGeneration", + "description": "Represent a generated video/animation.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "video", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "removed_for_safety", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if the video/animation was removed for safety, False otherwise." + }, + { + "key": "seed", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Seed used to generate the video/animation. It can be used to recreate the generation." + }, + { + "key": "safety_score", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "type_image-gen:VideoGenerationResponse": { + "name": "VideoGenerationResponse", + "description": "Response to an VideoGenerationRequest.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "videos", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_image-gen:VideoGeneration" + } + }, + "description": "List of VideoGeneration(s) generated by the request." + }, + { + "key": "prediction_time_ms", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Total runtime of the video(s) generation(s)." + } + ] + } + }, + "type_text-gen:Stop": { + "name": "Stop", + "description": "Strings that stop the generation when they are generated.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_text-gen:Prompt": { + "name": "Prompt", + "description": "The prompt to generate completions from.", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + ] + } + }, + "type_text-gen:ChatCompletionChoice": { + "name": "ChatCompletionChoice", + "description": "A single chat completion choice. A response will contain one or\nmore of these based on the setting of `n`.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:FinishReason" + } + } + }, + { + "key": "index", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "A unique identifier for the chat completion.Each chunk has the same ID." + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Logprobs" + } + } + }, + { + "key": "message", + "valueShape": { + "type": "id", + "id": "type_text-gen:ChatMessage" + }, + "description": "A chat completion message generated by the model." + } + ] + } + }, + "type_text-gen:ChatCompletionChunk": { + "name": "ChatCompletionChunk", + "description": "Represents a single chunk of a streaming chat completion response.\n\nThis object's schema is compatible with OpenAI's Chat Completion API.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "choices", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:ChatCompletionChunkChoice" + } + }, + "description": "A list of chat completion choices.Can be more than one if n is greater than 1." + }, + { + "key": "created", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A unique identifier for the entire chat completion request. Each chunk in the stream has the same ID." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model used for the chat completion." + }, + { + "key": "object", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "usage", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:UsageStats" + } + } + } + ] + } + }, + "type_text-gen:ChatCompletionChunkChoice": { + "name": "ChatCompletionChunkChoice", + "description": "An OpenAPI compatible schema for a chat completion chunk choice.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "delta", + "valueShape": { + "type": "id", + "id": "type_text-gen:ChatCompletionDelta" + } + }, + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:FinishReason" + } + } + }, + { + "key": "index", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Logprobs" + } + } + } + ] + } + }, + "type_text-gen:ChatCompletionDelta": { + "name": "ChatCompletionDelta", + "description": "An OpenAPI compatible schema for a chat completion choice delta.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_text-gen:ChatCompletionRequestExt": { + "name": "ChatCompletionRequestExt", + "description": "OctoAI specific extensions for a chat completion request.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vllm", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:ChatCompletionRequestExtVLLM" + } + } + } + ] + } + }, + "type_text-gen:ChatCompletionRequestExtVLLM": { + "name": "ChatCompletionRequestExtVLLM", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "best_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": 1 + } + } + } + }, + { + "key": "ignore_eos", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "skip_special_tokens", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "stop_token_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + { + "key": "top_k", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer", + "default": -1 + } + } + } + }, + { + "key": "use_beam_search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_text-gen:ChatCompletionResponse": { + "name": "ChatCompletionResponse", + "description": "An OpenAI API compatible schema for a chat completion response object.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "choices", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:ChatCompletionChoice" + } + }, + "description": "A list of chat completion choices.Can be more than one if n is greater than 1." + }, + { + "key": "created", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A unique identifier for the chat completion." + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The model used for the chat completion." + }, + { + "key": "object", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "usage", + "valueShape": { + "type": "id", + "id": "type_text-gen:UsageStats" + }, + "description": "Usage statistics for the completion request." + } + ] + } + }, + "type_text-gen:ChatCompletionResponseFormat": { + "name": "ChatCompletionResponseFormat", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schema", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_text-gen:ChatMessage": { + "name": "ChatMessage", + "description": "An OpenAI API compatible schema for a single ChatMessage.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The role of the author of this message." + } + ] + } + }, + "type_text-gen:CompletionChoice": { + "name": "CompletionChoice", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "finish_reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:FinishReason" + } + } + }, + { + "key": "index", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + { + "key": "logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:Logprobs" + } + } + }, + { + "key": "text", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_text-gen:CompletionResponse": { + "name": "CompletionResponse", + "description": "Represents a completion response from the API.\nNote: both the streamed and non-streamed response objects\nshare the same shape (unlike the chat endpoint).", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "choices", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:CompletionChoice" + } + } + }, + { + "key": "created", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The Unix timestamp (in seconds) of when the completion was created." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "model", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "object", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "system_fingerprint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "usage", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:UsageStats" + } + } + } + ] + } + }, + "type_text-gen:ErrorResponseValidationErrorsValue": { + "name": "ErrorResponseValidationErrorsValue", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_text-gen:ErrorResponse": { + "name": "ErrorResponse", + "description": "An OpenAI API compatible schema for a error response.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "message", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "object", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string", + "default": "error" + } + } + } + }, + { + "key": "param", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "validation_errors", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:ErrorResponseValidationErrorsValue" + } + } + } + } + } + ] + } + }, + "type_text-gen:FinishReason": { + "name": "FinishReason", + "description": "The reason why the model stopped generating tokens.\n\nThis will be `stop` if the model naturally completed generation or encountered a\nprovided stop sequence, `length` if the maximum number of tokens specified in the\nrequest was reached, content_filter if content was omitted due to a flag from our\ncontent filters, tool_calls if the model called a tool, or function_call\n(deprecated) if the model called a function.", + "shape": { + "type": "enum", + "values": [ + { + "value": "stop" + }, + { + "value": "length" + }, + { + "value": "tool_calls" + }, + { + "value": "content_filter" + }, + { + "value": "function_call" + }, + { + "value": "cancelled" + } + ] + } + }, + "type_text-gen:FunctionCall": { + "name": "FunctionCall", + "description": "The representation of a function called during tool use.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "arguments", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The arguments to the function call." + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The name of the function to call." + } + ] + } + }, + "type_text-gen:HTTPValidationError": { + "name": "HTTPValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:ValidationError" + } + } + } + } + ] + } + }, + "type_text-gen:Logprobs": { + "name": "Logprobs", + "description": "An OpenAI API compatible schema for logprobs output.\nSee details in https://platform.openai.com/docs/api-reference/chat/object#chat-create-logprobs", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_text-gen:LogprobsContent" + } + } + } + }, + "description": "List of logprobs info" + } + ] + } + }, + "type_text-gen:LogprobsContent": { + "name": "LogprobsContent", + "description": "An OpenAI API compatible schema for logprobs output.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bytes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "logprob", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Logprob corresponding to the token" + }, + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "New generated token or token from prompt for loglikelihood case" + }, + { + "key": "top_logprobs", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:TopLogprobs" + } + } + }, + "description": "List of top tokens info" + } + ] + } + }, + "type_text-gen:StreamOptions": { + "name": "StreamOptions", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "include_usage", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not to include token usage stats on the final chunk before the [Done] message." + } + ] + } + }, + "type_text-gen:ToolCall": { + "name": "ToolCall", + "description": "An OpenAI API compatible schema for a tool invocation.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_text-gen:FunctionCall" + }, + "description": "The function called by the model." + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A unique ID for the tool call used to reference it in the response." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_text-gen:TopLogprobs": { + "name": "TopLogprobs", + "description": "An OpenAI API compatible schema for logprobs output.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bytes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "logprob", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Logprob corresponding to the top token" + }, + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Token from the top list" + } + ] + } + }, + "type_text-gen:UsageStats": { + "name": "UsageStats", + "description": "The token usage statistics for a request.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completion_tokens", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of tokens in the prompt." + }, + { + "key": "prompt_tokens", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Number of tokens in the prompt." + }, + { + "key": "total_tokens", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Total number of tokens used in the request (prompt + completion)." + } + ] + } + }, + "type_text-gen:ValidationErrorLocItem": { + "name": "ValidationErrorLocItem", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + ] + } + }, + "type_text-gen:ValidationError": { + "name": "ValidationError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "loc", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_text-gen:ValidationErrorLocItem" + } + } + }, + { + "key": "msg", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + } + }, + "subpackages": { + "subpackage_asset-library": { + "id": "subpackage_asset-library", + "name": "asset-library" + }, + "subpackage_fine-tuning": { + "id": "subpackage_fine-tuning", + "name": "fine-tuning" + }, + "subpackage_image-gen": { + "id": "subpackage_image-gen", + "name": "image-gen" + }, + "subpackage_text-gen": { + "id": "subpackage_text-gen", + "name": "text-gen" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "api_key" + } + } + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/node.json b/packages/fdr-sdk/src/__test__/output/octoai/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/node.json rename to packages/fdr-sdk/src/__test__/output/octoai/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/octoai/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/octoai/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/octoai/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/octoai/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/pageIds.json b/packages/fdr-sdk/src/__test__/output/octoai/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/pageIds.json rename to packages/fdr-sdk/src/__test__/output/octoai/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/sitemap.json b/packages/fdr-sdk/src/__test__/output/octoai/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/sitemap.json rename to packages/fdr-sdk/src/__test__/output/octoai/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/octoai/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/octoai/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/octoai/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/octoai/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/octoai/slugs.json b/packages/fdr-sdk/src/__test__/output/octoai/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/octoai/slugs.json rename to packages/fdr-sdk/src/__test__/output/octoai/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/versionNodes.json b/packages/fdr-sdk/src/__test__/output/octoai/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/octoai/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-4f9d4e39-a928-4c8a-b9d0-308434722f10.json b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-4f9d4e39-a928-4c8a-b9d0-308434722f10.json new file mode 100644 index 0000000000..1ddc520cad --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-4f9d4e39-a928-4c8a-b9d0-308434722f10.json @@ -0,0 +1,3576 @@ +[ + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/path/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/query/refresh_schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/query/include_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/path/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/path/schema_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/path/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/automatically_add_new_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/automatically_add_new_objects", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/destination_configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/destination_connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/disable_record_timestamps", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/discover", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/source_configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object/property/source_connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/query/refresh_schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/query/refresh_schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/automatically_add_new_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/automatically_add_new_objects", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/destination_configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/destination_connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/disable_record_timestamps", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/discover", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/source_configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object/property/source_connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/request/object/property/resync", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/request/object/property/schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/request/object/property/test", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/path/exec_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/query/filters", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/request/object/property/schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/path/schema_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/path/schema_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/enabled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/partition_key", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object/property/redirect_url", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object/property/validate", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request/object/property/connection", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request/object/property/redirect_url", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request/object/property/whitelist", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/query/force", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object/property/reconnect", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object/property/validate", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/6/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/6/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/6/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/6/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/request/object/property/query", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/query/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/query/search", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/request/object/property/refresh", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/request/object/property/target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/path/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/path/schema_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/path/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/request/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/query/async", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/query/async", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/query/async", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/query/async", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/query/async", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/additional_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/enricher", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/identifier", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/labels", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/relations", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object/property/tracking_columns", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/query/async", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/query/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/query/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/query/starting_after", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/query/ending_before", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/query/limit", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/path/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request/object/property/client_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request/object/property/client_secret", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request/object/property/issuer", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request/object/property/sso_domain", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request/object/property/sso_org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request/object/property/client_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request/object/property/client_secret", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request/object/property/issuer", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request/object/property/sso_domain", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request/object/property/sso_org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/path/org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/path/org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/request/object/property/email", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/request/object/property/role", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/path/org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/path/org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/path/org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/request/object/property/email", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/request/object/property/role", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/path/org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/query/force", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/request/object/property/policy_actions", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/request/object/property/policy_actions", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/enricher", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/filter_logic", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/filters", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/identity", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/override_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/overrides", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/sync_all_records", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object/property/target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/enricher", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/filter_logic", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/filters", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/identity", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/override_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/overrides", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/sync_all_records", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object/property/target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/6/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/6/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/6/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/6/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/request/object/property/identities", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/request/object/property/resync", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/4/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/4/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/5/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/5/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/5/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/5/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/path/sync_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/path/sync_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/path/sync_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/path/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/path/sync_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/path/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/path/filename", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/4/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/4/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/request/object/property/endpoint", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/request/object/property/secret", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/path/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/request/object/property/endpoint", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/request/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/request/object/property/secret", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/0/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/0/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/0/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/0/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/1/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/1/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/1/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/1/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/2/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/2/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/2/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/2/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/3/snippet/curl/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/3/snippet/python/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/3/snippet/typescript/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/3/snippet/go/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ApiError/shape/object/property/message", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ApiError/shape/object/property/metadata", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ApiError/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkDiscover/shape/enum/value/all", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkDiscover/shape/enum/value/onlyIncremental", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkDiscover/shape/enum/value/onlyNonIncremental", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkDiscover/shape/enum/value/none", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/created", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/scheduled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/running", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/exporting", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/canceling", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/canceled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/completed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/failed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/processing", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape/enum/value/errors", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkItemizedSchedule/shape/object/property/item", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkItemizedSchedule/shape/object/property/schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkMultiScheduleConfiguration/shape/object/property/schedules", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkMultiScheduleConfiguration/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object/property/day_of_month", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object/property/day_of_week", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object/property/frequency", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object/property/hour", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object/property/minute", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object/property/month", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object/property/multi", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/created", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/scheduled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/running", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/exporting", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/canceled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/completed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/failed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSelectiveMode/shape/enum/value/none", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSelectiveMode/shape/enum/value/incrementalFields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSelectiveMode/shape/enum/value/nonincrementalFields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFieldReferenceType/shape/enum/value/Model", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFieldReferenceType/shape/enum/value/Target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/Equality", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/Inequality", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/IsNull", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/IsNotNull", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/True", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/False", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/OnOrAfter", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/OnOrBefore", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/GreaterThan", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/GreaterThanEqual", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/LessThan", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/LessThanEqual", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringContains", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringEndsWith", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringDoesNotContain", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringDoesNotEndWith", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringOneOf", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringNotOneOf", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/Between", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/ArrayContains", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/ArrayDoesNotContain", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/InTheLast", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringLike", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringNotLike", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape/enum/value/StringMatchesTrimmed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelModelFieldRequest/shape/object/property/example", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelModelFieldRequest/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelModelFieldRequest/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelModelFieldRequest/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelation/shape/object/property/from", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelation/shape/object/property/to", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelationTo/shape/object/property/field", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelationTo/shape/object/property/model_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RestErrResponse/shape/object/property/code", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RestErrResponse/shape/object/property/context", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RestErrResponse/shape/object/property/error", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RestErrResponse/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/manual", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/continuous", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/hourly", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/daily", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/weekly", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/custom", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/builder", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/runafter", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/multi", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape/enum/value/dbtcloud", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleScheduleOption/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleScheduleOption/shape/object/property/description", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleScheduleOption/shape/object/property/frequency", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleScheduleOption/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaAssociation/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaAssociation/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaAssociation/shape/object/property/reference_to", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaAssociation/shape/object/property/referenced_field", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaIdentityFunction/shape/enum/value/Equality", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaIdentityFunction/shape/enum/value/ISubstring", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaIdentityFunction/shape/enum/value/OneOf", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/does_not_report_operation_counts", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/new_target_label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/optional_target_mappings", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/primary_metadata_object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/requires_configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_field_creation", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_field_type_selection", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_target_filters", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/target_creator", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object/property/use_field_names_as_labels", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/created", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/scheduled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/queued", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/waiting", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/running", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/processing", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/canceling", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/canceled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/completed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/failed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape/enum/value/interrupted", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponse/shape/object/property/value", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncInput/shape/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncOutput/shape/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncOutput/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDest/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDest/shape/object/property/modes", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDestEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncListEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/destination_configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/destination_connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/discover", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/source_configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object/property/source_connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConfigurationValue/shape/object/property/items", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConfigurationValue/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionListResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMeta/shape/object/property/has_items", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMeta/shape/object/property/items", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMeta/shape/object/property/requires_one_of", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMetaResponse/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMetaResponse/shape/object/property/items", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMetaResponse/shape/object/property/requires_one_of", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValue/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValue/shape/object/property/value", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResp/shape/object/property/allows_creation", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResp/shape/object/property/values", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/api_calls_last_24_hours", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/status_error", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionType/shape/object/property/envConfig", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionType/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionType/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionType/shape/object/property/use_oauth", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeSchema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeSchema/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeSchema/shape/object/property/operations", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/auth_code", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/auth_url", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/status_error", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/additional_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/enricher", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/identifier", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/labels", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/relations", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object/property/tracking_columns", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment/shape/object/property/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment/shape/object/property/enricher_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment/shape/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment/shape/object/property/mappings", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event/shape/object/property/created_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event/shape/object/property/event", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventTypesEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventsEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionCounts/shape/object/property/error", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionCounts/shape/object/property/insert", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionCounts/shape/object/property/total", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionCounts/shape/object/property/update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogResponse/shape/object/property/expires", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogResponse/shape/object/property/urls", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogsResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape/object/property/field", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape/object/property/field_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape/object/property/field_type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape/object/property/function", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape/object/property/value", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetConnectionMetaEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/completed_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/counts", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/created_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/errors", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/started_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/email", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_organization", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_partner", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_system", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_user", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/organization_name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object/property/role", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity/shape/object/property/function", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity/shape/object/property/new_field", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity/shape/object/property/remote_field_type_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity/shape/object/property/source", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity/shape/object/property/target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:IdentityFunction/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:IdentityFunction/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse/shape/object/property/error", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse/shape/object/property/job_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse/shape/object/property/result", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListExecutionResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListPoliciesResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListModelSyncResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListUsersEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape/object/property/description", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape/object/property/mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape/object/property/requires_identity", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape/object/property/supports_field_sync_mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape/object/property/supports_target_filters", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/description", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/example", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/remote_type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/unique", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object/property/user_added", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelFieldResponse/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelListResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/enricher", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/identifier", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/labels", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/relations", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/tracking_columns", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object/property/version", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponseEnvelope/shape/object/property/job", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSample/shape/object/property/records", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSample/shape/object/property/warnings", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSampleResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSampleResponseEnvelope/shape/object/property/job", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization/shape/object/property/issuer", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization/shape/object/property/sso_domain", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization/shape/object/property/sso_org_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationsEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override/shape/object/property/field", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override/shape/object/property/field_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override/shape/object/property/function", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override/shape/object/property/override", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override/shape/object/property/value", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyAction/shape/object/property/action", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyAction/shape/object/property/role_ids", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse/shape/object/property/policy_actions", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse/shape/object/property/system", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Relation/shape/object/property/from", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Relation/shape/object/property/to", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RelationTo/shape/object/property/field", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RelationTo/shape/object/property/model_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleListResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponse/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponse/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponse/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponse/shape/object/property/system", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RunAfter/shape/object/property/bulk_sync_ids", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RunAfter/shape/object/property/sync_ids", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/day_of_month", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/day_of_week", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/frequency", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/hour", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/job_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/minute", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/month", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object/property/run_after", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponse/shape/object/property/schedule_options", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Source/shape/object/property/field", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Source/shape/object/property/model_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/created_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape/object/property/description", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape/object/property/requires_identity", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape/object/property/supports_field_sync_mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape/object/property/supports_target_filters", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField/shape/object/property/new", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField/shape/object/property/override_value", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField/shape/object/property/source", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField/shape/object/property/sync_mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField/shape/object/property/target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/active", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/filter_logic", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/filters", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/identity", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/override_fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/overrides", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/policies", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/sync_all_records", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object/property/target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusResponse/shape/object/property/current_execution", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusResponse/shape/object/property/last_execution", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusResponse/shape/object/property/next_execution_time", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape/object/property/connection_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape/object/property/filter_logic", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape/object/property/new_name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape/object/property/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape/object/property/search_values", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/association", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/createable", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/description", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/filterable", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/identity_functions", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/required", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/source_type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/supports_identity", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object/property/updateable", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape/object/property/modes", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape/object/property/properties", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape/object/property/refreshed_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:User/shape/object/property/email", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:User/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:User/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:User/shape/object/property/role", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:UserEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook/shape/object/property/created_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook/shape/object/property/endpoint", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook/shape/object/property/organization_id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook/shape/object/property/secret", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookListEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkField/shape/object/property/enabled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkField/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkField/shape/object/property/obfuscated", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema/shape/object/property/enabled", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema/shape/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema/shape/object/property/output_name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema/shape/object/property/partition_key", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/completed_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/created_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/is_resync", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/is_test", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/started_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecutionEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/completed_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/error_count", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/record_count", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/schema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/started_at", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/status_message", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSource/shape/object/property/configuration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSource/shape/object/property/schemas", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceSchemaEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatus/shape/object/property/cache_status", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatus/shape/object/property/last_refresh_finished", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatus/shape/object/property/last_refresh_started", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatusEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusResponse/shape/object/property/current_execution", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusResponse/shape/object/property/last_execution", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusResponse/shape/object/property/next_execution_time", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponse/shape/object/property/redirect_url", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponse/shape/object/property/token", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSchema/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSyncExecutionsEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PickValue/shape/object/property/label", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PickValue/shape/object/property/value", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schema/shape/object/property/fields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schema/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schema/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape/object/property/association", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape/object/property/id", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape/object/property/name", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape/object/property/remote_type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape/object/property/type", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape/object/property/values", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaRecordsResponseEnvelope/shape/object/property/data", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WorkTaskStatus/shape/enum/value/running", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WorkTaskStatus/shape/enum/value/done", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WorkTaskStatus/shape/enum/value/failed", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/global-headers/X-Polytomic-Version", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/3/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/2/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/3/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/4/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/5/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/error/1/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/error/1/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/error/1/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/error/1/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/error/1/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/3/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/4/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/5/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/1/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/2/403/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/3/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/4/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/0/400/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/1/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/2/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/3/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/error/1/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/error/1/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/error/1/404/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/response", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/error/0/401/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/error/1/422/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/error/2/500/error/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JsonschemaForm/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:LabelLabel/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2EnricherConfiguration/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2EnricherMapping/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2SampleRecord/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/request/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ApiError/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkItemizedSchedule/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkMultiScheduleConfiguration/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelModelFieldRequest/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelation/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelationTo/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RestErrResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleScheduleOption/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaAssociation/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncInput/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncOutput/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDest/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDestEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncListEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConfigurationValue/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionListResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMeta/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMetaResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValue/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResp/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionType/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventTypesEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventsEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionCounts/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogsResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetConnectionMetaEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:IdentityFunction/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListExecutionResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListPoliciesResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListModelSyncResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListUsersEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelFieldResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelListResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSample/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSampleResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationsEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyAction/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Relation/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RelationTo/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleListResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RunAfter/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Source/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:User/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:UserEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookListEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkField/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecutionEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSource/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceSchemaEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatus/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatusEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponse/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSchema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSyncExecutionsEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PickValue/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schema/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaRecordsResponseEnvelope/shape/object", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkDiscover/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSelectiveMode/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFieldReferenceType/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JsonschemaForm", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:LabelLabel", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaIdentityFunction/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2EnricherConfiguration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2EnricherMapping", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2SampleRecord", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WorkTaskStatus/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/3/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/2/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/3/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/4/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/error/5/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/example/6", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/error/1/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/error/1/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/error/1/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/error/1/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/error/1/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/3/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/4/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/error/5/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/example/6", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/1/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/2/403", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/3/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/error/4/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/example/5", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/0/400", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/1/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/2/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/error/3/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs/example/4", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/error/1/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/error/1/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/error/1/404", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/error/0/401", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/error/1/422", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/error/2/500", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/0", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/1", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/2", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/example/3", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update/request", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ApiError/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkDiscover", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkExecutionStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkItemizedSchedule/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkMultiScheduleConfiguration/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaExecutionStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSelectiveMode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFieldReferenceType", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:FilterFunction", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelModelFieldRequest/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelation/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelationTo/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RestErrResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleFrequency", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleScheduleOption/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaAssociation/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaIdentityFunction", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncInput/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncOutput/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDest/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDestEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncListEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConfigurationValue/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionListResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMeta/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMetaResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValue/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResp/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionType/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventTypesEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventsEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionCounts/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogsResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetConnectionMetaEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:IdentityFunction/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListExecutionResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListPoliciesResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListModelSyncResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListUsersEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelFieldResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelListResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSample/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSampleResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationsEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyAction/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Relation/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RelationTo/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleListResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RunAfter/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Source/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:User/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:UserEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookListEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkField/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecutionEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSource/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceSchemaEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatus/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatusEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponse/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSchema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSyncExecutionsEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PickValue/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schema/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaRecordsResponseEnvelope/shape", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WorkTaskStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ApiError", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkItemizedSchedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkMultiScheduleConfiguration", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelModelFieldRequest", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelation", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelRelationTo", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RestErrResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleScheduleOption", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaAssociation", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncDestinationProperties", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:APIKeyResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncInput", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ActivateSyncOutput", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDest", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncDestEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncListEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConfigurationValue", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionListResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMeta", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionMetaResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValue", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResp", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionParameterValuesResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionResponseSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionType", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectionTypeSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateConnectionResponseSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:CreateModelRequest", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Enrichment", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Event", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventTypesEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:EventsEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionCounts", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ExecutionLogsResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Filter", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetConnectionMetaEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetExecutionResponseSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:GetIdentityResponseSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Identity", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:IdentityFunction", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:JobResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListExecutionResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListPoliciesResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListModelSyncResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListUsersEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Mode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelField", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelFieldResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelListResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSample", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSampleResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Organization", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:OrganizationsEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Override", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyAction", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PolicyResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Relation", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RelationTo", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleListResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RoleResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:RunAfter", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schedule", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ScheduleOptionResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Source", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:StartModelSyncResponseSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SupportedMode", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncField", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ModelSyncResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SyncStatusResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Target", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetField", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:TargetResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:User", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:UserEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Webhook", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:WebhookListEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkField", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSchemaEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecution", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncExecutionEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSchemaExecution", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSource", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceSchemaEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncSourceStatusEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:BulkSyncStatusResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponse", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ConnectCardResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:ListBulkSyncExecutionsEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:PickValue", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:Schema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaField", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/type-definition/type_:SchemaRecordsResponseEnvelope", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetDestination", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSource", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceSchema", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetSourceStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Activate", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.Start", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync.GetStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/executions.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Patch", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_bulkSync/schemas.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTypes", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Connect", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetParameterValues", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSource", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetSourceFields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTarget", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_connections.GetTargetFields", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_schemas.GetRecords", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Post", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Preview", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_models.Sample", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_events.GetTypes", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_jobs.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_identity.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_organization.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_users.CreateApiKey", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/policies.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_permissions/roles.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetScheduleOptions", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Update", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Activate", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.Start", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync.GetStatus", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogUrls", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_modelSync/executions.GetLogs", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.List", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Create", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Get", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Remove", + "4f9d4e39-a928-4c8a-b9d0-308434722f10/endpoint/endpoint_webhooks.Update" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9212af81-e9e3-43ce-bb7e-997fe422dfe3.json b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9212af81-e9e3-43ce-bb7e-997fe422dfe3.json new file mode 100644 index 0000000000..ea46368318 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9212af81-e9e3-43ce-bb7e-997fe422dfe3.json @@ -0,0 +1,352 @@ +[ + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/request/object/property/configuration", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/request/object/property/name", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/request/object/property/organization_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/request/object/property/type", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/4/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/4/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/4/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/5/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/request/object/property/configuration", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/request/object/property/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/request/object/property/name", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/request/object/property/organization_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/request/object/property/type", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/4/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/5/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/request/object/property/name", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/request/object/property/sso_domain", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/request/object/property/sso_org_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/request/object/property/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/request/object/property/name", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/request/object/property/sso_domain", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/request/object/property/sso_org_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/path/org_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/request/object/property/email", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/request/object/property/organization_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/request/object/property/role", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/path/org_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/path/org_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/path/org_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/request/object/property/email", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/request/object/property/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/request/object/property/organization_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/request/object/property/role", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/request/object/property/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/request/object/property/identities", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/3/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/4/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/5/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/path/sync_id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/path/id", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/curl/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:ApiError/shape/object/property/message", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:ApiError/shape/object/property/metadata", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:ApiError/shape/object/property/status", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:RestErrResponse/shape/object/property/code", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:RestErrResponse/shape/object/property/context", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:RestErrResponse/shape/object/property/error", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:RestErrResponse/shape/object/property/status", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:V1TopLevelResponse/shape/object/property/error", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:V1TopLevelResponse/shape/object/property/result", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/global-headers/X-Polytomic-Version", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/error/1/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/1/403/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/2/422/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/3/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/0/400/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/1/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/2/404/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/3/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/1/403/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/2/404/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/3/422/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/4/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/0/400/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/1/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/2/403/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/3/422/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/4/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/error/1/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/error/1/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/error/1/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/error/1/422/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/error/2/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/error/1/422/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/error/2/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/error/1/404/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/error/2/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/error/1/404/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/error/2/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/0/400/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/1/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/2/403/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/3/404/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/4/500/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/response", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/error/0/401/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/error/1/404/error/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/request/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/request/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/request/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/request/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/request/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/request/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/request/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:ApiError/shape/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:RestErrResponse/shape/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:V1TopLevelResponse/shape/object", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/error/1/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/1/403", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/2/422", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/error/3/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/example/4", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/0/400", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/1/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/2/404", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/error/3/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get/example/4", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/1/403", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/2/404", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/3/422", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/error/4/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/4", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove/example/5", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/0/400", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/1/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/2/403", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/3/422", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/error/4/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/4", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/example/5", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/error/1/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/error/1/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/error/1/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/error/1/422", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/error/2/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/error/1/422", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/error/2/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/error/1/404", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/error/2/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/error/1/404", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/error/2/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/0/400", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/1/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/2/403", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/3/404", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/error/4/500", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/3", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/4", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/example/5", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/error/0/401", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/error/1/404", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/example/0", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/example/1", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get/example/2", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create/request", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update/request", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create/request", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update/request", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create/request", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update/request", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start/request", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:ApiError/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:RestErrResponse/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:V1TopLevelResponse/shape", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:ApiError", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:RestErrResponse", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/type-definition/type_:V1TopLevelResponse", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.GetTypes", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.List", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Create", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Get", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Remove", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_connections.Update", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_identity.api/v1.GetIdentity", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.List", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Create", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Get", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_organization.Update", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Create", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Get", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Remove", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_users.Update", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.List", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Get", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync.Start", + "9212af81-e9e3-43ce-bb7e-997fe422dfe3/endpoint/endpoint_modelSync/executions.Get" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9b972bf3-4f92-48dd-8a15-386f34ae82e1.json b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9b972bf3-4f92-48dd-8a15-386f34ae82e1.json new file mode 100644 index 0000000000..4b4842e924 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-9b972bf3-4f92-48dd-8a15-386f34ae82e1.json @@ -0,0 +1,2309 @@ +[ + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/query/refresh_schemas", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/automatically_add_new_fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/automatically_add_new_objects", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/destination_configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/destination_connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/disable_record_timestamps", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/discover", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/schemas", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/source_configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object/property/source_connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/query/refresh_schemas", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/query/refresh_schemas", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/automatically_add_new_fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/automatically_add_new_objects", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/destination_configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/destination_connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/disable_record_timestamps", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/discover", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/schemas", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/source_configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object/property/source_connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/query/filters", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/request/object/property/schemas", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/path/schema_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/path/schema_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/enabled", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/partition_key", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object/property/redirect_url", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object/property/validate", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/query/force", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object/property/reconnect", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object/property/validate", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/6/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/request/object/property/query", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/query/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/query/search", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/request/object/property/refresh", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/request/object/property/target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/path/connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/request/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/query/async", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/query/async", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/query/async", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/query/async", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/query/async", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/additional_fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/enricher", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/identifier", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/labels", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/relations", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object/property/tracking_columns", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/query/async", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/query/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/query/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/query/starting_after", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/query/ending_before", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/query/limit", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/path/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request/object/property/client_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request/object/property/client_secret", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request/object/property/issuer", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request/object/property/sso_domain", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request/object/property/sso_org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request/object/property/client_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request/object/property/client_secret", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request/object/property/issuer", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request/object/property/sso_domain", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request/object/property/sso_org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/path/org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/path/org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/request/object/property/email", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/request/object/property/role", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/path/org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/path/org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/path/org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/request/object/property/email", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/request/object/property/role", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/path/org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/query/force", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/request/object/property/policy_actions", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/request/object/property/policy_actions", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/enricher", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/filter_logic", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/filters", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/identity", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/override_fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/overrides", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/sync_all_records", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object/property/target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/enricher", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/filter_logic", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/filters", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/identity", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/override_fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/overrides", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/sync_all_records", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object/property/target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/6/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/request/object/property/identities", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/request/object/property/resync", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/5/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/path/sync_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/path/sync_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/path/sync_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/path/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/path/sync_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/path/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/path/filename", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/4/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/request/object/property/endpoint", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/request/object/property/secret", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/path/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/request/object/property/endpoint", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/request/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/request/object/property/secret", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/0/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/1/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/2/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/3/snippet/curl/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ApiError/shape/object/property/message", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ApiError/shape/object/property/metadata", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ApiError/shape/object/property/status", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkDiscover/shape/enum/value/all", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkDiscover/shape/enum/value/onlyIncremental", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkDiscover/shape/enum/value/onlyNonIncremental", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkDiscover/shape/enum/value/none", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkItemizedSchedule/shape/object/property/item", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkItemizedSchedule/shape/object/property/schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkMultiScheduleConfiguration/shape/object/property/schedules", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkMultiScheduleConfiguration/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object/property/day_of_month", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object/property/day_of_week", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object/property/frequency", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object/property/hour", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object/property/minute", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object/property/month", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object/property/multi", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSelectiveMode/shape/enum/value/none", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSelectiveMode/shape/enum/value/incrementalFields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSelectiveMode/shape/enum/value/nonincrementalFields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFieldReferenceType/shape/enum/value/Model", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFieldReferenceType/shape/enum/value/Target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/Equality", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/Inequality", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/IsNull", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/IsNotNull", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/True", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/False", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/OnOrAfter", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/OnOrBefore", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/GreaterThan", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/GreaterThanEqual", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/LessThan", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/LessThanEqual", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringContains", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringEndsWith", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringDoesNotContain", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringDoesNotEndWith", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringOneOf", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringNotOneOf", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/Between", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/ArrayContains", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/ArrayDoesNotContain", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/InTheLast", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringLike", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringNotLike", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape/enum/value/StringMatchesTrimmed", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelModelFieldRequest/shape/object/property/example", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelModelFieldRequest/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelModelFieldRequest/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelModelFieldRequest/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelation/shape/object/property/from", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelation/shape/object/property/to", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelationTo/shape/object/property/field", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelationTo/shape/object/property/model_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RestErrResponse/shape/object/property/code", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RestErrResponse/shape/object/property/context", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RestErrResponse/shape/object/property/error", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RestErrResponse/shape/object/property/status", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/manual", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/continuous", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/hourly", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/daily", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/weekly", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/custom", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/builder", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/runafter", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/multi", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape/enum/value/dbtcloud", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleScheduleOption/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleScheduleOption/shape/object/property/description", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleScheduleOption/shape/object/property/frequency", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleScheduleOption/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SchemaIdentityFunction/shape/enum/value/Equality", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SchemaIdentityFunction/shape/enum/value/ISubstring", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SchemaIdentityFunction/shape/enum/value/OneOf", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/does_not_report_operation_counts", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/new_target_label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/optional_target_mappings", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/primary_metadata_object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/requires_configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_field_creation", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_field_type_selection", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_target_filters", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/target_creator", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object/property/use_field_names_as_labels", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/created", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/scheduled", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/queued", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/waiting", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/running", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/processing", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/canceling", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/canceled", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/completed", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/failed", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape/enum/value/interrupted", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponse/shape/object/property/value", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncInput/shape/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncOutput/shape/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncOutput/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchema/shape/object/property/enabled", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchema/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchema/shape/object/property/partition_key", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchemaEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDest/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDest/shape/object/property/modes", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDestEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncListEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/destination_configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/destination_connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/discover", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/source_configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object/property/source_connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSource/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSource/shape/object/property/schemas", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSourceEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConfigurationValue/shape/object/property/items", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConfigurationValue/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionListResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMeta/shape/object/property/has_items", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMeta/shape/object/property/items", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMeta/shape/object/property/requires_one_of", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMetaResponse/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMetaResponse/shape/object/property/items", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMetaResponse/shape/object/property/requires_one_of", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValue/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValue/shape/object/property/value", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResp/shape/object/property/allows_creation", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResp/shape/object/property/values", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/api_calls_last_24_hours", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/status", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/status_error", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionType/shape/object/property/envConfig", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionType/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionType/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionType/shape/object/property/use_oauth", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeSchema/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeSchema/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeSchema/shape/object/property/operations", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/auth_code", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/auth_url", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/status", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/status_error", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/additional_fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/enricher", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/identifier", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/labels", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/relations", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object/property/tracking_columns", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment/shape/object/property/connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment/shape/object/property/enricher_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment/shape/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment/shape/object/property/mappings", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event/shape/object/property/created_at", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event/shape/object/property/event", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventTypesEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventsEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionCounts/shape/object/property/error", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionCounts/shape/object/property/insert", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionCounts/shape/object/property/total", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionCounts/shape/object/property/update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogResponse/shape/object/property/expires", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogResponse/shape/object/property/urls", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogsResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape/object/property/field", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape/object/property/field_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape/object/property/field_type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape/object/property/function", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape/object/property/value", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetConnectionMetaEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/completed_at", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/counts", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/created_at", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/errors", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/started_at", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/status", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/email", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_organization", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_partner", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_system", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_user", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/organization_name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object/property/role", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity/shape/object/property/function", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity/shape/object/property/new_field", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity/shape/object/property/remote_field_type_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity/shape/object/property/source", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity/shape/object/property/target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:IdentityFunction/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:IdentityFunction/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse/shape/object/property/error", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse/shape/object/property/job_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse/shape/object/property/result", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse/shape/object/property/status", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListBulkSchemaEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListExecutionResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListPoliciesResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListModelSyncResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListUsersEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape/object/property/description", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape/object/property/mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape/object/property/requires_identity", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape/object/property/supports_field_sync_mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape/object/property/supports_target_filters", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/description", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/example", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/remote_type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/unique", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object/property/user_added", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelFieldResponse/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelListResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/enricher", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/identifier", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/labels", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/relations", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/tracking_columns", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object/property/version", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponseEnvelope/shape/object/property/job", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSample/shape/object/property/records", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSample/shape/object/property/warnings", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSampleResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSampleResponseEnvelope/shape/object/property/job", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization/shape/object/property/issuer", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization/shape/object/property/sso_domain", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization/shape/object/property/sso_org_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationsEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override/shape/object/property/field", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override/shape/object/property/field_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override/shape/object/property/function", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override/shape/object/property/override", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override/shape/object/property/value", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyAction/shape/object/property/action", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyAction/shape/object/property/role_ids", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse/shape/object/property/policy_actions", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse/shape/object/property/system", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Relation/shape/object/property/from", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Relation/shape/object/property/to", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RelationTo/shape/object/property/field", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RelationTo/shape/object/property/model_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleListResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponse/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponse/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponse/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponse/shape/object/property/system", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RunAfter/shape/object/property/bulk_sync_ids", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RunAfter/shape/object/property/sync_ids", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/day_of_month", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/day_of_week", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/frequency", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/hour", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/job_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/minute", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/month", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object/property/run_after", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponse/shape/object/property/schedule_options", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Source/shape/object/property/field", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Source/shape/object/property/model_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/created_at", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/status", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape/object/property/description", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape/object/property/label", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape/object/property/requires_identity", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape/object/property/supports_field_sync_mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape/object/property/supports_target_filters", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField/shape/object/property/new", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField/shape/object/property/override_value", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField/shape/object/property/source", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField/shape/object/property/sync_mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField/shape/object/property/target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/active", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/filter_logic", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/filters", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/identity", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/override_fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/overrides", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/policies", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/sync_all_records", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object/property/target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusResponse/shape/object/property/current_execution", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusResponse/shape/object/property/last_execution", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusResponse/shape/object/property/next_execution_time", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape/object/property/configuration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape/object/property/connection_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape/object/property/filter_logic", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape/object/property/new_name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape/object/property/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape/object/property/search_values", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/association", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/createable", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/description", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/filterable", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/identity_functions", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/required", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/source_type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/supports_identity", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/type", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object/property/updateable", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape/object/property/fields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape/object/property/modes", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape/object/property/name", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape/object/property/properties", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape/object/property/refreshed_at", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponseEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:User/shape/object/property/email", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:User/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:User/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:User/shape/object/property/role", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:UserEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook/shape/object/property/created_at", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook/shape/object/property/endpoint", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook/shape/object/property/id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook/shape/object/property/organization_id", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook/shape/object/property/secret", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookListEnvelope/shape/object/property/data", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WorkTaskStatus/shape/enum/value/running", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WorkTaskStatus/shape/enum/value/done", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WorkTaskStatus/shape/enum/value/failed", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/global-headers/X-Polytomic-Version", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/3/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/3/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/4/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/5/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/error/1/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/error/1/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/error/1/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/error/1/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/error/1/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/3/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/4/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/5/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/1/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/2/403/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/3/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/4/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/0/400/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/1/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/2/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/3/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/error/1/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/error/1/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/error/1/404/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/response", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/error/0/401/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/error/1/422/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/error/2/500/error/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JsonschemaForm/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:LabelLabel/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2EnricherConfiguration/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2EnricherMapping/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2SampleRecord/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/request/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ApiError/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkItemizedSchedule/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkMultiScheduleConfiguration/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelModelFieldRequest/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelation/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelationTo/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RestErrResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleScheduleOption/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncInput/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncOutput/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchema/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchemaEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDest/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDestEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncListEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSource/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSourceEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConfigurationValue/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionListResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMeta/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMetaResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValue/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResp/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionType/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeSchema/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventTypesEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventsEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionCounts/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogsResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetConnectionMetaEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:IdentityFunction/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListBulkSchemaEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListExecutionResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListPoliciesResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListModelSyncResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListUsersEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelFieldResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelListResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSample/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSampleResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationsEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyAction/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Relation/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RelationTo/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleListResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RunAfter/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Source/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseSchema/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponseEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:User/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:UserEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookListEnvelope/shape/object", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkDiscover/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSelectiveMode/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFieldReferenceType/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JsonschemaForm", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:LabelLabel", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SchemaIdentityFunction/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2EnricherConfiguration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2EnricherMapping", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2SampleRecord", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WorkTaskStatus/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/3/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/3/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/4/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/error/5/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/example/6", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/error/1/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/error/1/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/error/1/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/error/1/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/error/1/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/3/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/4/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/error/5/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/example/6", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/1/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/2/403", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/3/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/error/4/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/example/5", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/0/400", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/1/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/2/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/error/3/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs/example/4", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/error/1/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/error/1/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/error/1/404", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/error/0/401", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/error/1/422", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/error/2/500", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/0", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/1", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/2", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/example/3", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update/request", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ApiError/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkDiscover", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkItemizedSchedule/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkMultiScheduleConfiguration/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSelectiveMode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFieldReferenceType", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:FilterFunction", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelModelFieldRequest/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelation/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelationTo/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RestErrResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleFrequency", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleScheduleOption/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SchemaIdentityFunction", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionStatus", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncInput/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncOutput/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchema/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchemaEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDest/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDestEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncListEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSource/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSourceEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConfigurationValue/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionListResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMeta/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMetaResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValue/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResp/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionType/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeSchema/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventTypesEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventsEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionCounts/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogsResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetConnectionMetaEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:IdentityFunction/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListBulkSchemaEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListExecutionResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListPoliciesResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListModelSyncResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListUsersEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelFieldResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelListResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSample/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSampleResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationsEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyAction/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Relation/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RelationTo/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleListResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RunAfter/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Source/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseSchema/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponseEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:User/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:UserEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookListEnvelope/shape", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WorkTaskStatus", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ApiError", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkItemizedSchedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkMultiScheduleConfiguration", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelModelFieldRequest", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelation", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelRelationTo", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RestErrResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleScheduleOption", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncDestinationProperties", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:APIKeyResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncInput", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ActivateSyncOutput", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchema", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSchemaEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDest", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncDestEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncListEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSource", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:BulkSyncSourceEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConfigurationValue", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionListResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMeta", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionMetaResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValue", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResp", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionParameterValuesResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionResponseSchema", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionType", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ConnectionTypeSchema", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateConnectionResponseSchema", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:CreateModelRequest", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Enrichment", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Event", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventTypesEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:EventsEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionCounts", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ExecutionLogsResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Filter", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetConnectionMetaEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetExecutionResponseSchema", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:GetIdentityResponseSchema", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Identity", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:IdentityFunction", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:JobResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListBulkSchemaEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListExecutionResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListPoliciesResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListModelSyncResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ListUsersEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Mode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelField", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelFieldResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelListResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSample", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSampleResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Organization", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:OrganizationsEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Override", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyAction", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:PolicyResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Relation", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RelationTo", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleListResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RoleResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:RunAfter", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Schedule", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ScheduleOptionResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Source", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:StartModelSyncResponseSchema", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SupportedMode", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncField", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:ModelSyncResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:SyncStatusResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Target", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetField", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponse", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:TargetResponseEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:User", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:UserEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:Webhook", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/type-definition/type_:WebhookListEnvelope", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetDestination", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.GetSource", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync.Activate", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Patch", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_bulkSync/schemas.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTypes", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetParameterValues", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSource", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetSourceFields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTarget", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_connections.GetTargetFields", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Post", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Preview", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_models.Sample", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_events.GetTypes", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_jobs.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_identity.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_organization.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_users.CreateApiKey", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/policies.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_permissions/roles.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetScheduleOptions", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Update", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Activate", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.Start", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync.GetStatus", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogUrls", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_modelSync/executions.GetLogs", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.List", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Create", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Get", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Remove", + "9b972bf3-4f92-48dd-8a15-386f34ae82e1/endpoint/endpoint_webhooks.Update" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-d051ed90-658a-4822-a2ee-f77a495b9085.json b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-d051ed90-658a-4822-a2ee-f77a495b9085.json new file mode 100644 index 0000000000..a8e61c9221 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitionKeys-d051ed90-658a-4822-a2ee-f77a495b9085.json @@ -0,0 +1,3693 @@ +[ + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/automatically_add_new_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/automatically_add_new_objects", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/destination_configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/destination_connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/disable_record_timestamps", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/discover", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/source_configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object/property/source_connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/query/refresh_schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/automatically_add_new_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/automatically_add_new_objects", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/destination_configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/destination_connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/disable_record_timestamps", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/discover", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/source_configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object/property/source_connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/query/refresh_schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/request/object/property/resync", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/request/object/property/schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/request/object/property/test", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/query/include_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/path/exec_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/query/filters", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/request/object/property/schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/path/schema_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/path/schema_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/enabled", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/request/object/property/partition_key", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object/property/redirect_url", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object/property/validate", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request/object/property/connection", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request/object/property/redirect_url", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request/object/property/whitelist", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object/property/reconnect", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object/property/validate", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/6/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/6/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/6/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/6/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/query/force", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/query/params", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/query/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/query/search", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/query/target", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/query/refresh", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/enricher", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/filter_logic", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/filters", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/identity", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/override_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/overrides", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/sync_all_records", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object/property/target", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/enricher", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/filter_logic", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/filters", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/identity", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/override_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/overrides", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/sync_all_records", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object/property/target", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/6/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/6/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/6/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/6/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/request/object/property/identities", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/request/object/property/resync", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/path/schema_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/path/schema_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/path/connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/request/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/query/async", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/query/async", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/query/async", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/query/async", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/additional_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/enricher", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/identifier", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/labels", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/relations", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object/property/tracking_columns", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/query/async", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/query/async", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/query/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/query/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/query/starting_after", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/query/ending_before", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/query/limit", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/path/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request/object/property/client_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request/object/property/client_secret", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request/object/property/issuer", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request/object/property/sso_domain", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request/object/property/sso_org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request/object/property/client_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request/object/property/client_secret", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request/object/property/issuer", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request/object/property/sso_domain", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request/object/property/sso_org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/path/org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/path/org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/request/object/property/email", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/request/object/property/role", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/path/org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/path/org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/request/object/property/email", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/request/object/property/role", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/path/org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/path/org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/query/force", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/request/object/property/policy_actions", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/request/object/property/policy_actions", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/request/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/5/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/5/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/5/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/5/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/path/sync_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/path/sync_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/path/sync_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/path/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/path/sync_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/path/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/path/filename", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/4/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/4/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/4/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/4/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/request/object/property/endpoint", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/request/object/property/secret", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/request/object/property/endpoint", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/request/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/request/object/property/secret", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/path/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/0/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/0/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/0/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/0/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/1/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/1/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/1/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/1/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/2/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/2/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/2/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/2/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/3/snippet/curl/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/3/snippet/python/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/3/snippet/typescript/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/3/snippet/go/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ApiError/shape/object/property/message", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ApiError/shape/object/property/metadata", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ApiError/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkDiscover/shape/enum/value/all", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkDiscover/shape/enum/value/onlyIncremental", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkDiscover/shape/enum/value/onlyNonIncremental", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkDiscover/shape/enum/value/none", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/created", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/scheduled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/running", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/exporting", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/canceling", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/canceled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/completed", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/failed", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/processing", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape/enum/value/errors", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkItemizedSchedule/shape/object/property/item", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkItemizedSchedule/shape/object/property/schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkMultiScheduleConfiguration/shape/object/property/schedules", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkMultiScheduleConfiguration/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object/property/day_of_month", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object/property/day_of_week", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object/property/frequency", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object/property/hour", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object/property/minute", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object/property/month", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object/property/multi", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/created", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/scheduled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/running", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/exporting", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/canceled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/completed", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape/enum/value/failed", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSelectiveMode/shape/enum/value/none", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSelectiveMode/shape/enum/value/incrementalFields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSelectiveMode/shape/enum/value/nonincrementalFields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFieldReferenceType/shape/enum/value/Model", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFieldReferenceType/shape/enum/value/Target", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/Equality", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/Inequality", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/IsNull", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/IsNotNull", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/True", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/False", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/OnOrAfter", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/OnOrBefore", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/GreaterThan", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/GreaterThanEqual", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/LessThan", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/LessThanEqual", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringContains", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringEndsWith", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringDoesNotContain", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringDoesNotEndWith", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringOneOf", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringNotOneOf", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/Between", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/ArrayContains", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/ArrayDoesNotContain", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/InTheLast", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringLike", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringNotLike", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape/enum/value/StringMatchesTrimmed", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelModelFieldRequest/shape/object/property/example", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelModelFieldRequest/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelModelFieldRequest/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelModelFieldRequest/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelation/shape/object/property/from", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelation/shape/object/property/to", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelationTo/shape/object/property/field", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelationTo/shape/object/property/model_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RestErrResponse/shape/object/property/code", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RestErrResponse/shape/object/property/context", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RestErrResponse/shape/object/property/error", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RestErrResponse/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/manual", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/continuous", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/hourly", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/daily", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/weekly", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/custom", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/builder", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/runafter", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/multi", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape/enum/value/dbtcloud", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleScheduleOption/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleScheduleOption/shape/object/property/description", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleScheduleOption/shape/object/property/frequency", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleScheduleOption/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaAssociation/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaAssociation/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaAssociation/shape/object/property/reference_to", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaAssociation/shape/object/property/referenced_field", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaIdentityFunction/shape/enum/value/Equality", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaIdentityFunction/shape/enum/value/ISubstring", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaIdentityFunction/shape/enum/value/OneOf", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/does_not_report_operation_counts", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/new_target_label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/optional_target_mappings", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/primary_metadata_object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/requires_configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_field_creation", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_field_type_selection", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/supports_target_filters", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/target_creator", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object/property/use_field_names_as_labels", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/created", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/scheduled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/queued", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/waiting", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/running", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/processing", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/canceling", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/canceled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/completed", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/failed", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape/enum/value/interrupted", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponse/shape/object/property/value", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncInput/shape/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncOutput/shape/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncOutput/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDest/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDest/shape/object/property/modes", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDestEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncListEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/destination_configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/destination_connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/discover", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/source_configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object/property/source_connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConfigurationValue/shape/object/property/items", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConfigurationValue/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionListResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMeta/shape/object/property/has_items", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMeta/shape/object/property/items", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMeta/shape/object/property/requires_one_of", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMetaResponse/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMetaResponse/shape/object/property/items", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMetaResponse/shape/object/property/requires_one_of", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValue/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValue/shape/object/property/value", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResp/shape/object/property/allows_creation", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResp/shape/object/property/values", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/api_calls_last_24_hours", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/status_error", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionType/shape/object/property/envConfig", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionType/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionType/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionType/shape/object/property/use_oauth", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeSchema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeSchema/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeSchema/shape/object/property/operations", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/auth_code", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/auth_url", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/status_error", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/additional_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/enricher", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/identifier", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/labels", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/relations", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object/property/tracking_columns", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment/shape/object/property/connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment/shape/object/property/enricher_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment/shape/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment/shape/object/property/mappings", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event/shape/object/property/created_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event/shape/object/property/event", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventTypesEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventsEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionCounts/shape/object/property/error", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionCounts/shape/object/property/insert", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionCounts/shape/object/property/total", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionCounts/shape/object/property/update", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogResponse/shape/object/property/expires", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogResponse/shape/object/property/urls", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogsResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape/object/property/field", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape/object/property/field_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape/object/property/field_type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape/object/property/function", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape/object/property/value", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetConnectionMetaEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/completed_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/counts", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/created_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/errors", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/started_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/email", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_organization", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_partner", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_system", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/is_user", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/organization_name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object/property/role", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity/shape/object/property/function", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity/shape/object/property/new_field", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity/shape/object/property/remote_field_type_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity/shape/object/property/source", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity/shape/object/property/target", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:IdentityFunction/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:IdentityFunction/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse/shape/object/property/error", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse/shape/object/property/job_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse/shape/object/property/result", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListExecutionResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListPoliciesResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListModelSyncResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListUsersEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape/object/property/description", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape/object/property/mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape/object/property/requires_identity", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape/object/property/supports_field_sync_mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape/object/property/supports_target_filters", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/description", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/example", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/remote_type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/unique", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object/property/user_added", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelFieldResponse/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelListResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/enricher", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/identifier", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/labels", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/relations", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/tracking_columns", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object/property/version", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponseEnvelope/shape/object/property/job", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSample/shape/object/property/records", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSample/shape/object/property/warnings", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSampleResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSampleResponseEnvelope/shape/object/property/job", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization/shape/object/property/issuer", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization/shape/object/property/sso_domain", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization/shape/object/property/sso_org_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationsEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override/shape/object/property/field", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override/shape/object/property/field_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override/shape/object/property/function", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override/shape/object/property/override", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override/shape/object/property/value", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyAction/shape/object/property/action", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyAction/shape/object/property/role_ids", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse/shape/object/property/policy_actions", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse/shape/object/property/system", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Relation/shape/object/property/from", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Relation/shape/object/property/to", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RelationTo/shape/object/property/field", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RelationTo/shape/object/property/model_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleListResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponse/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponse/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponse/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponse/shape/object/property/system", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RunAfter/shape/object/property/bulk_sync_ids", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RunAfter/shape/object/property/sync_ids", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/day_of_month", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/day_of_week", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/frequency", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/hour", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/job_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/minute", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/month", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object/property/run_after", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponse/shape/object/property/schedule_options", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Source/shape/object/property/field", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Source/shape/object/property/model_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/created_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseSchema/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape/object/property/description", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape/object/property/requires_identity", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape/object/property/supports_field_sync_mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape/object/property/supports_target_filters", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField/shape/object/property/new", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField/shape/object/property/override_value", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField/shape/object/property/source", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField/shape/object/property/sync_mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField/shape/object/property/target", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/active", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/filter_logic", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/filters", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/identity", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/override_fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/overrides", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/policies", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/sync_all_records", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object/property/target", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusResponse/shape/object/property/current_execution", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusResponse/shape/object/property/last_execution", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusResponse/shape/object/property/next_execution_time", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape/object/property/connection_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape/object/property/filter_logic", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape/object/property/new_name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape/object/property/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape/object/property/search_values", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/association", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/createable", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/description", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/filterable", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/identity_functions", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/required", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/source_type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/supports_identity", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object/property/updateable", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape/object/property/modes", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape/object/property/properties", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape/object/property/refreshed_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:User/shape/object/property/email", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:User/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:User/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:User/shape/object/property/role", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:UserEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook/shape/object/property/created_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook/shape/object/property/endpoint", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook/shape/object/property/organization_id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook/shape/object/property/secret", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookListEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkField/shape/object/property/enabled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkField/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkField/shape/object/property/obfuscated", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema/shape/object/property/enabled", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema/shape/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema/shape/object/property/output_name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema/shape/object/property/partition_key", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/completed_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/created_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/is_resync", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/is_test", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/started_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecutionEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/completed_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/error_count", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/record_count", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/schema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/started_at", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object/property/status_message", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSource/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSource/shape/object/property/schemas", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceSchemaEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatus/shape/object/property/cache_status", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatus/shape/object/property/last_refresh_finished", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatus/shape/object/property/last_refresh_started", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatusEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusResponse/shape/object/property/current_execution", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusResponse/shape/object/property/last_execution", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusResponse/shape/object/property/next_execution_time", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponse/shape/object/property/redirect_url", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponse/shape/object/property/token", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSchema/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSyncExecutionsEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PickValue/shape/object/property/label", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PickValue/shape/object/property/value", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schema/shape/object/property/fields", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schema/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schema/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape/object/property/association", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape/object/property/id", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape/object/property/name", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape/object/property/remote_type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape/object/property/type", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape/object/property/values", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaRecordsResponseEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetModelSyncSourceMetaEnvelope/shape/object/property/data", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SourceMeta/shape/object/property/has_items", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SourceMeta/shape/object/property/items", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SourceMeta/shape/object/property/requires_one_of", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncSourceMetaResponse/shape/object/property/configuration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncSourceMetaResponse/shape/object/property/items", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncSourceMetaResponse/shape/object/property/requires_one_of", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WorkTaskStatus/shape/enum/value/running", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WorkTaskStatus/shape/enum/value/done", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WorkTaskStatus/shape/enum/value/failed", + "d051ed90-658a-4822-a2ee-f77a495b9085/global-headers/X-Polytomic-Version", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/3/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/2/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/4/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/5/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/3/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/3/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/4/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/5/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/error/1/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/error/1/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/error/1/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/error/1/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/error/1/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/2/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/3/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/4/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/1/403/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/0/400/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/1/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/2/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/3/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/error/1/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/error/1/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/response", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/error/1/422/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/error/0/401/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/error/1/404/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/error/2/500/error/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JsonschemaForm/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:LabelLabel/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2EnricherConfiguration/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2EnricherMapping/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2SampleRecord/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/request/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ApiError/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkItemizedSchedule/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkMultiScheduleConfiguration/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelModelFieldRequest/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelation/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelationTo/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RestErrResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleScheduleOption/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaAssociation/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncInput/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncOutput/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDest/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDestEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncListEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConfigurationValue/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionListResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMeta/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMetaResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValue/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResp/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionType/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventTypesEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventsEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionCounts/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogsResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetConnectionMetaEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:IdentityFunction/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListExecutionResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListPoliciesResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListModelSyncResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListUsersEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelFieldResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelListResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSample/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSampleResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationsEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyAction/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Relation/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RelationTo/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleListResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RunAfter/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Source/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:User/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:UserEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookListEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkField/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecutionEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSource/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceSchemaEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatus/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatusEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSchema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSyncExecutionsEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PickValue/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schema/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaRecordsResponseEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetModelSyncSourceMetaEnvelope/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SourceMeta/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncSourceMetaResponse/shape/object", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkDiscover/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSelectiveMode/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFieldReferenceType/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JsonschemaForm", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:LabelLabel", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaIdentityFunction/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2EnricherConfiguration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2EnricherMapping", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2SampleRecord", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WorkTaskStatus/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/3/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/2/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/4/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/error/5/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/example/6", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/3/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/3/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/4/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/error/5/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/example/6", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/error/1/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/error/1/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/error/1/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/error/1/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/error/1/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/2/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/3/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/error/4/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/example/5", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/1/403", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/0/400", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/1/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/2/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/error/3/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs/example/4", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/error/1/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/error/1/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/error/1/422", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/error/0/401", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/error/1/404", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/error/2/500", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/0", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/1", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/2", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove/example/3", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update/request", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ApiError/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkDiscover", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkExecutionStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkItemizedSchedule/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkMultiScheduleConfiguration/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaExecutionStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSelectiveMode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFieldReferenceType", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:FilterFunction", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelModelFieldRequest/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelation/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelationTo/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RestErrResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleFrequency", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleScheduleOption/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaAssociation/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaIdentityFunction", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncInput/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncOutput/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDest/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDestEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncListEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConfigurationValue/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionListResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMeta/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMetaResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValue/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResp/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionType/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventTypesEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventsEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionCounts/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogsResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetConnectionMetaEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:IdentityFunction/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListExecutionResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListPoliciesResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListModelSyncResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListUsersEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelFieldResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelListResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSample/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSampleResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationsEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyAction/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Relation/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RelationTo/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleListResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RunAfter/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Source/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:User/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:UserEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookListEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkField/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecutionEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSource/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceSchemaEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatus/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatusEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSchema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSyncExecutionsEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PickValue/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schema/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaRecordsResponseEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetModelSyncSourceMetaEnvelope/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SourceMeta/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncSourceMetaResponse/shape", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WorkTaskStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ApiError", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkItemizedSchedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkMultiScheduleConfiguration", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelModelFieldRequest", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelation", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelRelationTo", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RestErrResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleScheduleOption", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaAssociation", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncDestinationProperties", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:APIKeyResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncInput", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ActivateSyncOutput", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDest", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncDestEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncListEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConfigurationValue", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionListResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMeta", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionMetaResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValue", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResp", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionParameterValuesResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionResponseSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionType", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectionTypeSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateConnectionResponseSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:CreateModelRequest", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Enrichment", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Event", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventTypesEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:EventsEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionCounts", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ExecutionLogsResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Filter", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetConnectionMetaEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:V2GetEnrichmentInputFieldsResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetExecutionResponseSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetIdentityResponseSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Identity", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:IdentityFunction", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:JobResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListExecutionResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListPoliciesResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListModelSyncResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListUsersEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Mode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelField", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelFieldResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelListResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSample", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSampleResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Organization", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:OrganizationsEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Override", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyAction", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PolicyResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Relation", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RelationTo", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleListResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RoleResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:RunAfter", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schedule", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ScheduleOptionResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Source", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:StartModelSyncResponseSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SupportedMode", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncField", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SyncStatusResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Target", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetField", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:TargetResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:User", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:UserEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Webhook", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:WebhookListEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkField", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSchemaEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecution", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncExecutionEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSchemaExecution", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSource", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceSchemaEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncSourceStatusEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:BulkSyncStatusResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ConnectCardResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSchema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ListBulkSyncExecutionsEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:PickValue", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:Schema", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaField", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SchemaRecordsResponseEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:GetModelSyncSourceMetaEnvelope", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:SourceMeta", + "d051ed90-658a-4822-a2ee-f77a495b9085/type-definition/type_:ModelSyncSourceMetaResponse", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Activate", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.Start", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetSource", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync.GetDestination", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/executions.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Patch", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_bulkSync/schemas.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetTypes", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Connect", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_connections.GetParameterValues", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSource", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetSourceFields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTarget", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetTargetFields", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetScheduleOptions", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Activate", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.Start", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync.GetStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Refresh", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetStatus", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_schemas.GetRecords", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Post", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Preview", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_models.Sample", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_events.GetTypes", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_jobs.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_identity.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_organization.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_users.CreateApiKey", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/policies.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_permissions/roles.Remove", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogUrls", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_modelSync/executions.GetLogs", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.List", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Create", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Get", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Update", + "d051ed90-658a-4822-a2ee-f77a495b9085/endpoint/endpoint_webhooks.Remove" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitions.json new file mode 100644 index 0000000000..1ca25a61e3 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/polytomic/apiDefinitions.json @@ -0,0 +1,102351 @@ +[ + { + "id": "9212af81-e9e3-43ce-bb7e-997fe422dfe3", + "endpoints": { + "endpoint_connections.GetTypes": { + "id": "endpoint_connections.GetTypes", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connection_types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connection_types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connection_types", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.List": { + "id": "endpoint_connections.List", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Create": { + "id": "endpoint_connections.Create", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Get": { + "id": "endpoint_connections.Get", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Remove": { + "id": "endpoint_connections.Remove", + "namespace": [ + "subpackage_connections" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/connections/id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Update": { + "id": "endpoint_connections.Update", + "namespace": [ + "subpackage_connections" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/id \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_identity.api/v1.GetIdentity": { + "id": "endpoint_identity.api/v1.GetIdentity", + "namespace": [ + "subpackage_identity" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/me" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/me", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.List": { + "id": "endpoint_organization.List", + "namespace": [ + "subpackage_organization" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Create": { + "id": "endpoint_organization.Create", + "namespace": [ + "subpackage_organization" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Get": { + "id": "endpoint_organization.Get", + "namespace": [ + "subpackage_organization" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Update": { + "id": "endpoint_organization.Update", + "namespace": [ + "subpackage_organization" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/id \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Create": { + "id": "endpoint_users.Create", + "namespace": [ + "subpackage_users" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/org_id/users", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "org_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/org_id/users \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Get": { + "id": "endpoint_users.Get", + "namespace": [ + "subpackage_users" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/org_id/users/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "org_id": "org_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/org_id/users/id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Remove": { + "id": "endpoint_users.Remove", + "namespace": [ + "subpackage_users" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/org_id/users/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "org_id": "org_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/org_id/users/id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Update": { + "id": "endpoint_users.Update", + "namespace": [ + "subpackage_users" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/org_id/users/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id", + "org_id": "org_id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/org_id/users/id \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.List": { + "id": "endpoint_modelSync.List", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Get": { + "id": "endpoint_modelSync.Get", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/id", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Start": { + "id": "endpoint_modelSync.Start", + "namespace": [ + "subpackage_modelSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identities", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/id/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/id/executions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.Get": { + "id": "endpoint_modelSync/executions.Get", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V1TopLevelResponse" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/sync_id/executions/id", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "sync_id", + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "key": "value" + }, + "result": { + "key": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/sync_id/executions/id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "error": "string", + "code": 0, + "context": { + "string": {} + }, + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2021-05-23" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2021-05-23\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:ApiError": { + "name": "ApiError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:RestErrResponse": { + "name": "RestErrResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Application-specific error code." + }, + { + "key": "context", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Application context." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Status text." + } + ] + } + }, + "type_:V1TopLevelResponse": { + "name": "V1TopLevelResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + } + }, + "subpackages": { + "subpackage_connections": { + "id": "subpackage_connections", + "name": "connections" + }, + "subpackage_identity": { + "id": "subpackage_identity", + "name": "identity" + }, + "subpackage_organization": { + "id": "subpackage_organization", + "name": "organization" + }, + "subpackage_users": { + "id": "subpackage_users", + "name": "users" + }, + "subpackage_modelSync": { + "id": "subpackage_modelSync", + "name": "modelSync" + }, + "subpackage_modelSync/executions": { + "id": "subpackage_modelSync/executions", + "name": "executions" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "token" + } + }, + "globalHeaders": [ + { + "key": "X-Polytomic-Version", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "2021-05-23" + } + } + } + } + ] + }, + { + "id": "9b972bf3-4f92-48dd-8a15-386f34ae82e1", + "endpoints": { + "endpoint_bulkSync.GetDestination": { + "id": "endpoint_bulkSync.GetDestination", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/dest/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncDestEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/dest/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "advanced": { + "items": { + "truncate_existing": { + "default": "", + "required": false + } + } + }, + "mirror_schemas": { + "default": "", + "required": false + }, + "schema": { + "default": "", + "required": false + } + }, + "modes": [ + { + "description": "Replace all records", + "id": "replace", + "label": "Replace", + "requires_identity": false, + "supports_field_sync_mode": false, + "supports_target_filters": false + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetSource": { + "id": "endpoint_bulkSync.GetSource", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/source/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncSourceEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "key": "value" + }, + "schemas": [ + "schemas" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.List": { + "id": "endpoint_bulkSync.List", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncListEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1" + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Create": { + "id": "endpoint_bulkSync.Create", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "automatically_add_new_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "automatically_add_new_objects", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "disable_record_timestamps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead" + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Bulk Sync", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"My Bulk Sync\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Get": { + "id": "endpoint_bulkSync.Get", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Remove": { + "id": "endpoint_bulkSync.Remove", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d?refresh_schemas=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Update": { + "id": "endpoint_bulkSync.Update", + "namespace": [ + "subpackage_bulkSync" + ], + "description": "> 📘 Updating schemas\n>\n> Schema updates can be performed using the [Update Bulk Sync Schemas](https://apidocs.polytomic.com/api-reference/bulk-sync/schemas/patch) endpoint.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "automatically_add_new_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "automatically_add_new_objects", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "disable_record_timestamps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead" + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Bulk Sync", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"My Bulk Sync\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Activate": { + "id": "endpoint_bulkSync.Activate", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/activate" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncInput" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.List": { + "id": "endpoint_bulkSync/schemas.List", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "enabled": true, + "id": "table", + "partition_key": "pk" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "filters": { + "string": "string" + } + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode filters={\"string\":\"string\"}", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "filters": { + "string": "string" + } + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode filters={\"string\":\"string\"}", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Patch": { + "id": "endpoint_bulkSync/schemas.Patch", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/id/schemas", + "responseStatusCode": 200, + "pathParameters": { + "id": "id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "enabled": true, + "id": "table", + "partition_key": "pk" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/id/schemas \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Get": { + "id": "endpoint_bulkSync/schemas.Get", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/table", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "table" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "enabled": true, + "id": "table", + "partition_key": "pk" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/table \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Update": { + "id": "endpoint_bulkSync/schemas.Update", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "partition_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/table", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "table" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "enabled": true, + "id": "table", + "partition_key": "pk" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/table \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetTypes": { + "id": "endpoint_connections.GetTypes", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connection_types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionTypeResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connection_types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "envConfig": { + "key": "value" + }, + "id": "postgresql", + "name": "PostgreSQL", + "use_oauth": true + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connection_types", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connection_types", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.List": { + "id": "endpoint_connections.List", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "api_calls_last_24_hours": 2021, + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Create": { + "id": "endpoint_connections.Create", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "redirect_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL to redirect to after completing OAuth flow." + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "validate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Validate connection configuration." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Postgres Connection", + "type": "postgresql" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "auth_code": "auth_code", + "auth_url": "auth_url", + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Postgres Connection\",\n \"type\": \"postgresql\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Get": { + "id": "endpoint_connections.Get", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "api_calls_last_24_hours": 2021, + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Remove": { + "id": "endpoint_connections.Remove", + "namespace": [ + "subpackage_connections" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "force", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "force": true + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d?force=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Update": { + "id": "endpoint_connections.Update", + "namespace": [ + "subpackage_connections" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "reconnect", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "validate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Validate connection configuration." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Postgres Connection" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "auth_code": "auth_code", + "auth_url": "auth_url", + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Postgres Connection\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetParameterValues": { + "id": "endpoint_connections.GetParameterValues", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/parameter_values" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionParameterValuesResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/parameter_values", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "data": { + "allows_creation": true, + "values": [ + {} + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/parameter_values \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetSource": { + "id": "endpoint_connections.GetSource", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/source" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetConnectionMetaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "configuration": {} + }, + "items": { + "items": { + "has_items": true + } + }, + "requires_one_of": [ + "requires_one_of" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetSourceFields": { + "id": "endpoint_connections.GetSourceFields", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/source/fields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "query", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelFieldResponse" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source/fields", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "description": "Unique identifier", + "example": { + "key": "value" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source/fields \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetTarget": { + "id": "endpoint_connections.GetTarget", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/target" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetConnectionMetaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "type": "table", + "search": "public.users" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "configuration": {} + }, + "items": { + "items": { + "has_items": true + } + }, + "requires_one_of": [ + "requires_one_of" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target \\\n -H \"Authorization: Bearer \" \\\n -d type=table \\\n -d search=public.users", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetTargetFields": { + "id": "endpoint_connections.GetTargetFields", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/target/fields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "refresh", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:TargetResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target/fields", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "target": "database.table" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "fields": [ + { + "association": false, + "createable": true, + "description": "Field description", + "filterable": true, + "id": "field1", + "name": "Field", + "required": true, + "source_type": "string", + "supports_identity": false, + "type": "string", + "updateable": true + } + ], + "id": "database.table", + "modes": [ + { + "description": "Create records when they don't exist; don't update existing ones", + "label": "Create", + "mode": "create", + "requires_identity": true, + "supports_field_sync_mode": false, + "supports_target_filters": false + } + ], + "name": "Table", + "properties": { + "does_not_report_operation_counts": true, + "new_target_label": "new_target_label", + "optional_target_mappings": true, + "primary_metadata_object": "primary_metadata_object", + "requires_configuration": true, + "supports_field_creation": true, + "supports_field_type_selection": true, + "supports_target_filters": true, + "target_creator": true, + "use_field_names_as_labels": true + }, + "refreshed_at": "2024-01-01T00:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target/fields \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"database.table\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Post": { + "id": "endpoint_models.Post", + "namespace": [ + "subpackage_models" + ], + "description": "For a given connection and enrichment configuration, provides the valid sets of input fields.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/enrichment/" + }, + { + "type": "pathParameter", + "value": "connection_id" + }, + { + "type": "literal", + "value": "/inputfields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherConfiguration" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V2GetEnrichmentInputFieldsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields", + "responseStatusCode": 200, + "pathParameters": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + [ + "data" + ] + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 401, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 403, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 404, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 500, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Preview": { + "id": "endpoint_models.Preview", + "namespace": [ + "subpackage_models" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/model-preview" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateModelRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/model-preview", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/model-preview \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.List": { + "id": "endpoint_models.List", + "namespace": [ + "subpackage_models" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Create": { + "id": "endpoint_models.Create", + "namespace": [ + "subpackage_models" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/models" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateModelRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/models \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Get": { + "id": "endpoint_models.Get", + "namespace": [ + "subpackage_models" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Remove": { + "id": "endpoint_models.Remove", + "namespace": [ + "subpackage_models" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Update": { + "id": "endpoint_models.Update", + "namespace": [ + "subpackage_models" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "additional_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelModelFieldRequest" + } + } + } + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelRelation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "async": false + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d?async=false\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Sample": { + "id": "endpoint_models.Sample", + "namespace": [ + "subpackage_models" + ], + "description": "Returns sample records from the model. The first ten records that the source provides will be returned after being enriched (if applicable). Synchronous requests must complete within 10s. If either querying or enrichment exceeds 10s, please use the async option.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/sample" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSampleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d/sample", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "records": [ + { + "records": {} + } + ], + "warnings": [ + "Enrichment failed for 4 records: you have ran out of credits" + ] + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d/sample \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_events.List": { + "id": "endpoint_events.List", + "namespace": [ + "subpackage_events" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/events" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "starting_after", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "ending_before", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EventsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/events", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "starting_after": "2020-01-01T00:00:00Z", + "ending_before": "2020-01-01T00:00:00Z" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "created_at": "2024-01-01T00:00:00Z", + "event": { + "key": "value" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "sync.running" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=248df4b7-aa70-47b8-a036-33ac447e668d \\\n --data-urlencode starting_after=2020-01-01T00:00:00Z \\\n --data-urlencode ending_before=2020-01-01T00:00:00Z", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ] + } + } + ] + }, + "endpoint_events.GetTypes": { + "id": "endpoint_events.GetTypes", + "namespace": [ + "subpackage_events" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/events_types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EventTypesEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/events_types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + "data" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/events_types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/events_types", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/events_types \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_jobs.Get": { + "id": "endpoint_jobs.Get", + "namespace": [ + "subpackage_jobs" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/jobs/" + }, + { + "type": "pathParameter", + "value": "type" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:JobResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/jobs/createmodel/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "createmodel" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/createmodel/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_identity.Get": { + "id": "endpoint_identity.Get", + "namespace": [ + "subpackage_identity" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/me" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetIdentityResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/me", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_organization": false, + "is_partner": false, + "is_system": false, + "is_user": true, + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_name": "My Organization", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.List": { + "id": "endpoint_organization.List", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Create": { + "id": "endpoint_organization.Create", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "client_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "client_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Organization" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Organization\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Get": { + "id": "endpoint_organization.Get", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Remove": { + "id": "endpoint_organization.Remove", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Update": { + "id": "endpoint_organization.Update", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "client_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "client_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Organization" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Organization\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.List": { + "id": "endpoint_users.List", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListUsersEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 404, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Create": { + "id": "endpoint_users.Create", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "email": "mail@example.com" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"mail@example.com\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 422, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 500, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Get": { + "id": "endpoint_users.Get", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Remove": { + "id": "endpoint_users.Remove", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Update": { + "id": "endpoint_users.Update", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "email": "mail@example.com" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"mail@example.com\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.CreateApiKey": { + "id": "endpoint_users.CreateApiKey", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/keys" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "force", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:APIKeyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d/keys", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "force": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "value": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d/keys?force=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 404, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 500, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.List": { + "id": "endpoint_permissions/policies.List", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListPoliciesResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Create": { + "id": "endpoint_permissions/policies.Create", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Get": { + "id": "endpoint_permissions/policies.Get", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Remove": { + "id": "endpoint_permissions/policies.Remove", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Update": { + "id": "endpoint_permissions/policies.Update", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.List": { + "id": "endpoint_permissions/roles.List", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Create": { + "id": "endpoint_permissions/roles.Create", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Get": { + "id": "endpoint_permissions/roles.Get", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Remove": { + "id": "endpoint_permissions/roles.Remove", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Update": { + "id": "endpoint_permissions/roles.Update", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.List": { + "id": "endpoint_modelSync.List", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "search_values": { + "name": "value" + } + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Create": { + "id": "endpoint_modelSync.Create", + "namespace": [ + "subpackage_modelSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + }, + "description": "Values to set as sync target fields." + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + }, + "description": "Conditional value replacement for field mappings." + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:Schedule" + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "id", + "id": "type_:Target" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "mode": "create", + "name": "Users Sync", + "schedule": {}, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"create\",\n \"name\": \"Users Sync\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"object\": \"Users\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetScheduleOptions": { + "id": "endpoint_modelSync.GetScheduleOptions", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/schedules" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ScheduleOptionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/schedules", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "schedule_options": [ + { + "description": "Runs when manually triggered", + "label": "Manual" + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/schedules", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/schedules", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Get": { + "id": "endpoint_modelSync.Get", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Remove": { + "id": "endpoint_modelSync.Remove", + "namespace": [ + "subpackage_modelSync" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Update": { + "id": "endpoint_modelSync.Update", + "namespace": [ + "subpackage_modelSync" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + }, + "description": "Values to set as sync target fields." + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + }, + "description": "Conditional value replacement for field mappings." + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:Schedule" + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "id", + "id": "type_:Target" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "mode": "create", + "name": "Users Sync", + "schedule": {}, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"create\",\n \"name\": \"Users Sync\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"object\": \"Users\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Activate": { + "id": "endpoint_modelSync.Activate", + "namespace": [ + "subpackage_modelSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/activate" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncInput" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Start": { + "id": "endpoint_modelSync.Start", + "namespace": [ + "subpackage_modelSync" + ], + "description": "> 🚧 Force full resync\n>\n> Use caution when setting the `resync` parameter to `true`. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "identities", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "resync", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:StartModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "status": "created" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetStatus": { + "id": "endpoint_modelSync.GetStatus", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SyncStatusEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "current_execution": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + }, + "last_execution": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + }, + "next_execution_time": "2024-01-01T00:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.List": { + "id": "endpoint_modelSync/executions.List", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListExecutionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.Get": { + "id": "endpoint_modelSync/executions.Get", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetExecutionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.GetLogUrls": { + "id": "endpoint_modelSync/executions.GetLogUrls", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "type" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ExecutionLogsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "records" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "expires": "2024-01-01T00:00:00Z", + "urls": [ + "urls" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 400, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.GetLogs": { + "id": "endpoint_modelSync/executions.GetLogs", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "type" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "filename" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records/path/to/file.json", + "responseStatusCode": 204, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "records", + "filename": "path/to/file.json" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records/path/to/file.json \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 400, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.List": { + "id": "endpoint_webhooks.List", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookListEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Create": { + "id": "endpoint_webhooks.Create", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 6, + "maxLength": 6 + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "endpoint": "https://example.com/webhook", + "secret": "secret" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"https://example.com/webhook\",\n \"secret\": \"secret\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Get": { + "id": "endpoint_webhooks.Get", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Remove": { + "id": "endpoint_webhooks.Remove", + "namespace": [ + "subpackage_webhooks" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Update": { + "id": "endpoint_webhooks.Update", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 6, + "maxLength": 6 + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "endpoint": "https://example.com/webhook", + "secret": "secret" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"https://example.com/webhook\",\n \"secret\": \"secret\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2022-12-12" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2022-12-12\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:ApiError": { + "name": "ApiError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BulkDiscover": { + "name": "BulkDiscover", + "shape": { + "type": "enum", + "values": [ + { + "value": "all" + }, + { + "value": "onlyIncremental" + }, + { + "value": "onlyNonIncremental" + }, + { + "value": "none" + } + ] + } + }, + "type_:BulkItemizedSchedule": { + "name": "BulkItemizedSchedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "item", + "valueShape": { + "type": "id", + "id": "type_:BulkSelectiveMode" + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + } + ] + } + }, + "type_:BulkMultiScheduleConfiguration": { + "name": "BulkMultiScheduleConfiguration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schedules", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkItemizedSchedule" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:BulkSchedule": { + "name": "BulkSchedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "day_of_month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_week", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + }, + { + "key": "hour", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "minute", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "multi", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkMultiScheduleConfiguration" + } + } + } + ] + } + }, + "type_:BulkSelectiveMode": { + "name": "BulkSelectiveMode", + "shape": { + "type": "enum", + "values": [ + { + "value": "none" + }, + { + "value": "incrementalFields" + }, + { + "value": "nonincrementalFields" + } + ] + } + }, + "type_:FilterFieldReferenceType": { + "name": "FilterFieldReferenceType", + "shape": { + "type": "enum", + "values": [ + { + "value": "Model" + }, + { + "value": "Target" + } + ] + } + }, + "type_:FilterFunction": { + "name": "FilterFunction", + "shape": { + "type": "enum", + "values": [ + { + "value": "Equality" + }, + { + "value": "Inequality" + }, + { + "value": "IsNull" + }, + { + "value": "IsNotNull" + }, + { + "value": "True" + }, + { + "value": "False" + }, + { + "value": "OnOrAfter" + }, + { + "value": "OnOrBefore" + }, + { + "value": "GreaterThan" + }, + { + "value": "GreaterThanEqual" + }, + { + "value": "LessThan" + }, + { + "value": "LessThanEqual" + }, + { + "value": "StringContains" + }, + { + "value": "StringEndsWith" + }, + { + "value": "StringDoesNotContain" + }, + { + "value": "StringDoesNotEndWith" + }, + { + "value": "StringOneOf" + }, + { + "value": "StringNotOneOf" + }, + { + "value": "Between" + }, + { + "value": "ArrayContains" + }, + { + "value": "ArrayDoesNotContain" + }, + { + "value": "InTheLast" + }, + { + "value": "StringLike" + }, + { + "value": "StringNotLike" + }, + { + "value": "StringMatchesTrimmed" + } + ] + } + }, + "type_:JsonschemaForm": { + "name": "JsonschemaForm", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:LabelLabel": { + "name": "LabelLabel", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:ModelModelFieldRequest": { + "name": "ModelModelFieldRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "example", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ModelRelation": { + "name": "ModelRelation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "to", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelRelationTo" + } + } + } + ] + } + }, + "type_:ModelRelationTo": { + "name": "ModelRelationTo", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:RestErrResponse": { + "name": "RestErrResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Application-specific error code." + }, + { + "key": "context", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Application context." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Status text." + } + ] + } + }, + "type_:ScheduleFrequency": { + "name": "ScheduleFrequency", + "shape": { + "type": "enum", + "values": [ + { + "value": "manual" + }, + { + "value": "continuous" + }, + { + "value": "hourly" + }, + { + "value": "daily" + }, + { + "value": "weekly" + }, + { + "value": "custom" + }, + { + "value": "builder" + }, + { + "value": "runafter" + }, + { + "value": "multi" + }, + { + "value": "dbtcloud" + } + ] + } + }, + "type_:ScheduleScheduleOption": { + "name": "ScheduleScheduleOption", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JsonschemaForm" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:SchemaIdentityFunction": { + "name": "SchemaIdentityFunction", + "shape": { + "type": "enum", + "values": [ + { + "value": "Equality" + }, + { + "value": "ISubstring" + }, + { + "value": "OneOf" + } + ] + } + }, + "type_:SyncDestinationProperties": { + "name": "SyncDestinationProperties", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "does_not_report_operation_counts", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "new_target_label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "optional_target_mappings", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "primary_metadata_object", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_creation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_type_selection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target_creator", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "use_field_names_as_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ExecutionStatus": { + "name": "ExecutionStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "scheduled" + }, + { + "value": "queued" + }, + { + "value": "waiting" + }, + { + "value": "running" + }, + { + "value": "processing" + }, + { + "value": "canceling" + }, + { + "value": "canceled" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "interrupted" + } + ] + } + }, + "type_:APIKeyResponse": { + "name": "APIKeyResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:APIKeyResponseEnvelope": { + "name": "APIKeyResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:APIKeyResponse" + } + } + } + ] + } + }, + "type_:ActivateSyncEnvelope": { + "name": "ActivateSyncEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ActivateSyncOutput" + } + } + } + ] + } + }, + "type_:ActivateSyncInput": { + "name": "ActivateSyncInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + ] + } + }, + "type_:ActivateSyncOutput": { + "name": "ActivateSyncOutput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSchema": { + "name": "BulkSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "partition_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSchemaEnvelope": { + "name": "BulkSchemaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + ] + } + }, + "type_:BulkSyncDest": { + "name": "BulkSyncDest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "modes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SupportedMode" + } + } + } + } + ] + } + }, + "type_:BulkSyncDestEnvelope": { + "name": "BulkSyncDestEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncDest" + } + } + } + ] + } + }, + "type_:BulkSyncListEnvelope": { + "name": "BulkSyncListEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSyncResponse" + } + } + } + } + ] + } + }, + "type_:BulkSyncResponse": { + "name": "BulkSyncResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchedule" + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncResponseEnvelope": { + "name": "BulkSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncResponse" + } + } + } + ] + } + }, + "type_:BulkSyncSource": { + "name": "BulkSyncSource", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:BulkSyncSourceEnvelope": { + "name": "BulkSyncSourceEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncSource" + } + } + } + ] + } + }, + "type_:ConfigurationValue": { + "name": "ConfigurationValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ConnectionListResponseEnvelope": { + "name": "ConnectionListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionResponseSchema" + } + } + } + } + ] + } + }, + "type_:ConnectionMeta": { + "name": "ConnectionMeta", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "has_items", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ConnectionMetaResponse": { + "name": "ConnectionMetaResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:ConfigurationValue" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionMeta" + } + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ConnectionParameterValue": { + "name": "ConnectionParameterValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:ConnectionParameterValuesResp": { + "name": "ConnectionParameterValuesResp", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "allows_creation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "values", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionParameterValue" + } + } + } + } + ] + } + }, + "type_:ConnectionParameterValuesResponseEnvelope": { + "name": "ConnectionParameterValuesResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionParameterValuesResp" + } + } + } + } + } + ] + } + }, + "type_:ConnectionResponseEnvelope": { + "name": "ConnectionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionResponseSchema" + } + } + } + ] + } + }, + "type_:ConnectionResponseSchema": { + "name": "ConnectionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "api_calls_last_24_hours", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "API calls made to service in the last 24h (supported integrations only)." + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status_error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionTypeSchema" + } + } + } + ] + } + }, + "type_:ConnectionType": { + "name": "ConnectionType", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "envConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "use_oauth", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ConnectionTypeResponseEnvelope": { + "name": "ConnectionTypeResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionType" + } + } + } + } + ] + } + }, + "type_:ConnectionTypeSchema": { + "name": "ConnectionTypeSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "operations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:CreateConnectionResponseEnvelope": { + "name": "CreateConnectionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CreateConnectionResponseSchema" + } + } + } + ] + } + }, + "type_:CreateConnectionResponseSchema": { + "name": "CreateConnectionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "auth_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code to enter in order to complete connection authentication." + }, + { + "key": "auth_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL to visit to complete connection authentication." + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status_error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionTypeSchema" + } + } + } + ] + } + }, + "type_:CreateModelRequest": { + "name": "CreateModelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "additional_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelModelFieldRequest" + } + } + } + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelRelation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:V2EnricherConfiguration": { + "name": "V2EnricherConfiguration", + "description": "Similar to a model configuration, this configures the enricher. For example, if you wanted to use Apollo to enrich people, you would send `{\"object\": \"people\"}` as the configuration. Each enricher configuration can be found in the connection configuration docs.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:V2EnricherMapping": { + "name": "V2EnricherMapping", + "description": "A map of parent model Source Name to child model Source Name. For example, if your model has a field called `work_email` and the enricher accepts a field called `email`, you'd send a map of `{\"work_email\":\"email\"}`. The set of required input mappings varies based on the configuration of the enrichment. You can use the `enrichment/{connection_id}/inputfields` API to discover available input field combinations for a given configuration.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "type_:Enrichment": { + "name": "Enrichment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherConfiguration" + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "enricher_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Must be provided to update an existing enrichment" + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + }, + "description": "If not provided, all fields will be enabled." + }, + { + "key": "mappings", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherMapping" + } + } + } + ] + } + }, + "type_:Event": { + "name": "Event", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "event", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:EventTypesEnvelope": { + "name": "EventTypesEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:EventsEnvelope": { + "name": "EventsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Event" + } + } + } + } + ] + } + }, + "type_:ExecutionCounts": { + "name": "ExecutionCounts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "insert", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "update", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:ExecutionLogResponse": { + "name": "ExecutionLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "expires", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ExecutionLogsResponseEnvelope": { + "name": "ExecutionLogsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionLogResponse" + } + } + } + ] + } + }, + "type_:Filter": { + "name": "Filter", + "description": "Either `field` or `field_id` must be provided. If `field` is provided, `field_id` is ignored.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Source" + } + } + }, + { + "key": "field_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model or Target field name to filter on." + }, + { + "key": "field_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilterFieldReferenceType" + } + } + }, + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:FilterFunction" + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:GetConnectionMetaEnvelope": { + "name": "GetConnectionMetaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionMetaResponse" + } + } + } + ] + } + }, + "type_:V2GetEnrichmentInputFieldsResponseEnvelope": { + "name": "V2GetEnrichmentInputFieldsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "type_:GetExecutionResponseEnvelope": { + "name": "GetExecutionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + } + ] + } + }, + "type_:GetExecutionResponseSchema": { + "name": "GetExecutionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "counts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionCounts" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "errors", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "started_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:GetIdentityResponseEnvelope": { + "name": "GetIdentityResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetIdentityResponseSchema" + } + } + } + ] + } + }, + "type_:GetIdentityResponseSchema": { + "name": "GetIdentityResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "is_organization", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_partner", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Identity": { + "name": "Identity", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:SchemaIdentityFunction" + } + }, + { + "key": "new_field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "remote_field_type_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:IdentityFunction": { + "name": "IdentityFunction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:JobResponse": { + "name": "JobResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WorkTaskStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:JobResponseEnvelope": { + "name": "JobResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:ListBulkSchemaEnvelope": { + "name": "ListBulkSchemaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + } + ] + } + }, + "type_:ListExecutionResponseEnvelope": { + "name": "ListExecutionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + } + } + ] + } + }, + "type_:ListPoliciesResponseEnvelope": { + "name": "ListPoliciesResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyResponse" + } + } + } + } + ] + } + }, + "type_:ListModelSyncResponseEnvelope": { + "name": "ListModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncResponse" + } + } + } + } + ] + } + }, + "type_:ListUsersEnvelope": { + "name": "ListUsersEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:User" + } + } + } + } + ] + } + }, + "type_:Mode": { + "name": "Mode", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelField": { + "name": "ModelField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "example", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "remote_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "unique", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "user_added", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelFieldResponse": { + "name": "ModelFieldResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + } + } + ] + } + }, + "type_:ModelListResponseEnvelope": { + "name": "ModelListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelResponse" + } + } + } + } + ] + } + }, + "type_:ModelResponse": { + "name": "ModelResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LabelLabel" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Relation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:ModelResponseEnvelope": { + "name": "ModelResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelResponse" + } + } + }, + { + "key": "job", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:ModelSample": { + "name": "ModelSample", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:V2SampleRecord" + } + } + } + }, + { + "key": "warnings", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ModelSampleResponseEnvelope": { + "name": "ModelSampleResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelSample" + } + } + }, + { + "key": "job", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:Organization": { + "name": "Organization", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:OrganizationEnvelope": { + "name": "OrganizationEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Organization" + } + } + } + ] + } + }, + "type_:OrganizationsEnvelope": { + "name": "OrganizationsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Organization" + } + } + } + } + ] + } + }, + "type_:Override": { + "name": "Override", + "description": "Either `field` or `field_id` must be provided. If `field_id` is provided, `field` is ignored.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Source" + } + } + }, + { + "key": "field_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Field ID of the model field to override." + }, + { + "key": "function", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilterFunction" + } + } + }, + { + "key": "override", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:PolicyAction": { + "name": "PolicyAction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "action", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:PolicyResponse": { + "name": "PolicyResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + }, + { + "key": "system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:PolicyResponseEnvelope": { + "name": "PolicyResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PolicyResponse" + } + } + } + ] + } + }, + "type_:Relation": { + "name": "Relation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "to", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RelationTo" + } + } + } + ] + } + }, + "type_:RelationTo": { + "name": "RelationTo", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:RoleListResponseEnvelope": { + "name": "RoleListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RoleResponse" + } + } + } + } + ] + } + }, + "type_:RoleResponse": { + "name": "RoleResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:RoleResponseEnvelope": { + "name": "RoleResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RoleResponse" + } + } + } + ] + } + }, + "type_:RunAfter": { + "name": "RunAfter", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bulk_sync_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "sync_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:V2SampleRecord": { + "name": "V2SampleRecord", + "description": "A map of `fieldSource` -> `fieldName: fieldValue`. Because there may be field name conflicts between the base model and enrichments, the base model fields are placed in a map under the model ID. Fields from enrichments are placed under the enricher ID.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + }, + "type_:Schedule": { + "name": "Schedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_week", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + } + }, + { + "key": "hour", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "minute", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "run_after", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RunAfter" + } + } + } + ] + } + }, + "type_:ScheduleOptionResponse": { + "name": "ScheduleOptionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schedule_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ScheduleScheduleOption" + } + } + } + } + ] + } + }, + "type_:ScheduleOptionResponseEnvelope": { + "name": "ScheduleOptionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleOptionResponse" + } + } + } + ] + } + }, + "type_:Source": { + "name": "Source", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:StartModelSyncResponseEnvelope": { + "name": "StartModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StartModelSyncResponseSchema" + } + } + } + ] + } + }, + "type_:StartModelSyncResponseSchema": { + "name": "StartModelSyncResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionStatus" + } + } + } + ] + } + }, + "type_:SupportedMode": { + "name": "SupportedMode", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelSyncField": { + "name": "ModelSyncField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "new", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "override_value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ModelSyncResponse": { + "name": "ModelSyncResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Schedule" + } + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Target" + } + } + } + ] + } + }, + "type_:ModelSyncResponseEnvelope": { + "name": "ModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelSyncResponse" + } + } + } + ] + } + }, + "type_:SyncStatusEnvelope": { + "name": "SyncStatusEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SyncStatusResponse" + } + } + } + ] + } + }, + "type_:SyncStatusResponse": { + "name": "SyncStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "current_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + }, + { + "key": "last_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + }, + { + "key": "next_execution_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:Target": { + "name": "Target", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "new_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "object", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "search_values", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + ] + } + }, + "type_:TargetField": { + "name": "TargetField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "association", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "createable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filterable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identity_functions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:IdentityFunction" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "required", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "source_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "supports_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "updateable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:TargetResponse": { + "name": "TargetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TargetField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "modes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Mode" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "properties", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SyncDestinationProperties" + } + } + }, + { + "key": "refreshed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:TargetResponseEnvelope": { + "name": "TargetResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TargetResponse" + } + } + } + ] + } + }, + "type_:User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:UserEnvelope": { + "name": "UserEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:User" + } + } + } + ] + } + }, + "type_:Webhook": { + "name": "Webhook", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:WebhookEnvelope": { + "name": "WebhookEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Webhook" + } + } + } + ] + } + }, + "type_:WebhookListEnvelope": { + "name": "WebhookListEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Webhook" + } + } + } + } + ] + } + }, + "type_:WorkTaskStatus": { + "name": "WorkTaskStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "running" + }, + { + "value": "done" + }, + { + "value": "failed" + } + ] + } + } + }, + "subpackages": { + "subpackage_bulkSync": { + "id": "subpackage_bulkSync", + "name": "bulkSync" + }, + "subpackage_bulkSync/schemas": { + "id": "subpackage_bulkSync/schemas", + "name": "schemas" + }, + "subpackage_connections": { + "id": "subpackage_connections", + "name": "connections" + }, + "subpackage_models": { + "id": "subpackage_models", + "name": "models" + }, + "subpackage_events": { + "id": "subpackage_events", + "name": "events" + }, + "subpackage_jobs": { + "id": "subpackage_jobs", + "name": "jobs" + }, + "subpackage_identity": { + "id": "subpackage_identity", + "name": "identity" + }, + "subpackage_organization": { + "id": "subpackage_organization", + "name": "organization" + }, + "subpackage_users": { + "id": "subpackage_users", + "name": "users" + }, + "subpackage_permissions": { + "id": "subpackage_permissions", + "name": "permissions" + }, + "subpackage_permissions/policies": { + "id": "subpackage_permissions/policies", + "name": "policies" + }, + "subpackage_permissions/roles": { + "id": "subpackage_permissions/roles", + "name": "roles" + }, + "subpackage_modelSync": { + "id": "subpackage_modelSync", + "name": "modelSync" + }, + "subpackage_modelSync/executions": { + "id": "subpackage_modelSync/executions", + "name": "executions" + }, + "subpackage_webhooks": { + "id": "subpackage_webhooks", + "name": "webhooks" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "token" + } + }, + "globalHeaders": [ + { + "key": "X-Polytomic-Version", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "2022-12-12" + } + } + } + ] + }, + { + "id": "d051ed90-658a-4822-a2ee-f77a495b9085", + "endpoints": { + "endpoint_bulkSync.List": { + "id": "endpoint_bulkSync.List", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncListEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1" + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Create": { + "id": "endpoint_bulkSync.Create", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "automatically_add_new_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "automatically_add_new_objects", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "disable_record_timestamps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead" + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Bulk Sync", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"My Bulk Sync\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Get": { + "id": "endpoint_bulkSync.Get", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Update": { + "id": "endpoint_bulkSync.Update", + "namespace": [ + "subpackage_bulkSync" + ], + "description": "> 📘 Updating schemas\n>\n> Schema updates can be performed using the [Update Bulk Sync Schemas](https://apidocs.polytomic.com/api-reference/bulk-sync/schemas/patch) endpoint.", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "automatically_add_new_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "automatically_add_new_objects", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "disable_record_timestamps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead" + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Bulk Sync", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"My Bulk Sync\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Bulk Sync\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"My Bulk Sync\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Remove": { + "id": "endpoint_bulkSync.Remove", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d?refresh_schemas=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Activate": { + "id": "endpoint_bulkSync.Activate", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/activate" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncInput" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Start": { + "id": "endpoint_bulkSync.Start", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "resync", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "test", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncExecutionEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartBulkSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartBulkSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartBulkSyncRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetStatus": { + "id": "endpoint_bulkSync.GetStatus", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncStatusEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "current_execution": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + }, + "last_execution": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + }, + "next_execution_time": "2023-04-25T12:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/status", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/status", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/status", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetSource": { + "id": "endpoint_bulkSync.GetSource", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/bulksync/source" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "include_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncSourceEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/bulksync/source", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "include_fields": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "key": "value" + }, + "schemas": [ + { + "id": "contact", + "name": "Contact" + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/bulksync/source \\\n -H \"Authorization: Bearer \" \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/source", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/bulksync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/source", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/bulksync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/source", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/bulksync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/source", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/bulksync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetDestination": { + "id": "endpoint_bulkSync.GetDestination", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/bulksync/target" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncDestEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/bulksync/target", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "advanced": { + "items": { + "truncate_existing": { + "default": "", + "required": false + } + } + }, + "mirror_schemas": { + "default": "", + "required": false + }, + "schema": { + "default": "", + "required": false + } + }, + "modes": [ + { + "description": "Replace all records", + "id": "replace", + "label": "Replace", + "requires_identity": false, + "supports_field_sync_mode": false, + "supports_target_filters": false + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/bulksync/target \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/target", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/bulksync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/target", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/bulksync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/target", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/bulksync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/bulksync/target", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/bulksync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/executions.List": { + "id": "endpoint_bulkSync/executions.List", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSyncExecutionsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/executions.Get": { + "id": "endpoint_bulkSync/executions.Get", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "exec_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "exec_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncExecutionEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "exec_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n exec_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions/:exec_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "exec_id": ":exec_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions/:exec_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n exec_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions/:exec_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "exec_id": ":exec_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions/:exec_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n exec_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.List": { + "id": "endpoint_bulkSync/schemas.List", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSchema" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.SchemasListRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "filters": { + "string": "string" + } + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode filters={\"string\":\"string\"}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.SchemasListRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "filters": { + "string": "string" + } + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode filters={\"string\":\"string\"}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.SchemasListRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Patch": { + "id": "endpoint_bulkSync/schemas.Patch", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSchema" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.patch(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.patch(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.patch(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.patch(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.patch(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.patch(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.patch(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.patch(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.patch(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.patch(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Get": { + "id": "endpoint_bulkSync/schemas.Get", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/Contact", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "Contact" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/Contact \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"Contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"Contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"Contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"Contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"Contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"Contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"Contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"Contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"Contact\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Update": { + "id": "endpoint_bulkSync/schemas.Update", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkField" + } + } + } + }, + { + "key": "partition_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "contact" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetTypes": { + "id": "endpoint_connections.GetTypes", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connection_types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionTypeResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connection_types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "envConfig": { + "key": "value" + }, + "id": "postgresql", + "name": "PostgreSQL", + "use_oauth": true + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connection_types", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connection_types", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.List": { + "id": "endpoint_connections.List", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "api_calls_last_24_hours": 2021, + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Create": { + "id": "endpoint_connections.Create", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "redirect_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL to redirect to after completing OAuth flow." + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "validate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Validate connection configuration." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Postgres Connection", + "type": "postgresql" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "auth_code": "auth_code", + "auth_url": "auth_url", + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Postgres Connection\",\n \"type\": \"postgresql\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Postgres Connection\",\n type=\"postgresql\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.create({\n name: \"My Postgres Connection\",\n type: \"postgresql\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tType: \"postgresql\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Postgres Connection\",\n type=\"postgresql\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.create({\n name: \"My Postgres Connection\",\n type: \"postgresql\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tType: \"postgresql\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Postgres Connection\",\n type=\"postgresql\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.create({\n name: \"My Postgres Connection\",\n type: \"postgresql\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tType: \"postgresql\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Postgres Connection\",\n type=\"postgresql\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.create({\n name: \"My Postgres Connection\",\n type: \"postgresql\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tType: \"postgresql\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Postgres Connection\",\n type=\"postgresql\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.create({\n name: \"My Postgres Connection\",\n type: \"postgresql\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tType: \"postgresql\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Postgres Connection\",\n type=\"postgresql\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.create({\n name: \"My Postgres Connection\",\n type: \"postgresql\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tType: \"postgresql\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Connect": { + "id": "endpoint_connections.Connect", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections/connect/" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "connection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "redirect_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "whitelist", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectCardResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/connect/", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Salesforce Connection", + "redirect_url": "redirect_url" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "redirect_url": "https://example.com", + "token": "token" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Salesforce Connection\",\n \"redirect_url\": \"redirect_url\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.connect({\n name: \"Salesforce Connection\",\n redirect_url: \"redirect_url\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.connect({\n name: \"Salesforce Connection\",\n redirect_url: \"redirect_url\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.connect({\n name: \"Salesforce Connection\",\n redirect_url: \"redirect_url\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.connect({\n name: \"Salesforce Connection\",\n redirect_url: \"redirect_url\"\n});\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.connect({\n name: \"Salesforce Connection\",\n redirect_url: \"redirect_url\"\n});\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Get": { + "id": "endpoint_connections.Get", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "api_calls_last_24_hours": 2021, + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Update": { + "id": "endpoint_connections.Update", + "namespace": [ + "subpackage_connections" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "reconnect", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "validate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Validate connection configuration." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Postgres Connection" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "auth_code": "auth_code", + "auth_url": "auth_url", + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Postgres Connection\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Postgres Connection\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Postgres Connection\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Postgres Connection\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Postgres Connection\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Postgres Connection\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Postgres Connection\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Postgres Connection\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Postgres Connection\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Postgres Connection\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Postgres Connection\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Postgres Connection\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Postgres Connection\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Postgres Connection\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Postgres Connection\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Remove": { + "id": "endpoint_connections.Remove", + "namespace": [ + "subpackage_connections" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "force", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "force": true + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d?force=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetParameterValues": { + "id": "endpoint_connections.GetParameterValues", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/parameter_values" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionParameterValuesResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/parameter_values", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "data": { + "allows_creation": true, + "values": [ + {} + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/parameter_values \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetSource": { + "id": "endpoint_modelSync.GetSource", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/modelsync/source" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "params", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetModelSyncSourceMetaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/source", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "configuration": {} + }, + "requires_one_of": [ + "requires_one_of" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/source \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetSourceRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "params": { + "string": [ + "string" + ] + } + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode params={\"string\":[\"string\"]}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetSourceRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "params": { + "string": [ + "string" + ] + } + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode params={\"string\":[\"string\"]}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetSourceRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "params": { + "string": [ + "string" + ] + } + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode params={\"string\":[\"string\"]}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetSourceRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "params": { + "string": [ + "string" + ] + } + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode params={\"string\":[\"string\"]}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetSourceRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "params": { + "string": [ + "string" + ] + } + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/source \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode params={\"string\":[\"string\"]}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetSourceRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetSourceFields": { + "id": "endpoint_modelSync.GetSourceFields", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/modelsync/source/fields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelFieldResponse" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/source/fields", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "description": "Unique identifier", + "example": { + "key": "value" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/source/fields \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source/fields", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/modelsync/source/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source/fields", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/modelsync/source/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source/fields", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/modelsync/source/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source/fields", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/modelsync/source/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/source/fields", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/modelsync/source/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetTarget": { + "id": "endpoint_modelSync.GetTarget", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/modelsync/target" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetConnectionMetaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/target", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "configuration": {} + }, + "items": { + "items": { + "has_items": true + } + }, + "requires_one_of": [ + "requires_one_of" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/target \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetTargetFields": { + "id": "endpoint_modelSync.GetTargetFields", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/modelsync/target/fields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "refresh", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:TargetResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/target/fields", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "target": "database.table", + "refresh": false + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "fields": [ + { + "association": false, + "createable": true, + "description": "Field description", + "filterable": true, + "id": "field1", + "name": "Field", + "required": true, + "source_type": "string", + "supports_identity": false, + "type": "string", + "updateable": true + } + ], + "id": "database.table", + "modes": [ + { + "description": "Create records when they don't exist; don't update existing ones", + "label": "Create", + "mode": "create", + "requires_identity": true, + "supports_field_sync_mode": false, + "supports_target_filters": false + } + ], + "name": "Table", + "properties": { + "does_not_report_operation_counts": true, + "new_target_label": "new_target_label", + "optional_target_mappings": true, + "primary_metadata_object": "primary_metadata_object", + "requires_configuration": true, + "supports_field_creation": true, + "supports_field_type_selection": true, + "supports_target_filters": true, + "target_creator": true, + "use_field_names_as_labels": true + }, + "refreshed_at": "2024-01-01T00:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/target/fields \\\n -H \"Authorization: Bearer \" \\\n -d target=database.table \\\n -d refresh=false", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n target=\"database.table\",\n refresh=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n target: \"database.table\",\n refresh: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetFieldsRequest{\n\t\tTarget: \"database.table\",\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target/fields", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "target": "string", + "refresh": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d target=string \\\n -d refresh=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n target=\"database.table\",\n refresh=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n target: \"database.table\",\n refresh: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetFieldsRequest{\n\t\tTarget: \"database.table\",\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target/fields", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "target": "string", + "refresh": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d target=string \\\n -d refresh=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n target=\"database.table\",\n refresh=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n target: \"database.table\",\n refresh: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetFieldsRequest{\n\t\tTarget: \"database.table\",\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target/fields", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "target": "string", + "refresh": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d target=string \\\n -d refresh=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n target=\"database.table\",\n refresh=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n target: \"database.table\",\n refresh: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetFieldsRequest{\n\t\tTarget: \"database.table\",\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/modelsync/target/fields", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "target": "string", + "refresh": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/modelsync/target/fields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d target=string \\\n -d refresh=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n target=\"database.table\",\n refresh=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n target: \"database.table\",\n refresh: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelSyncGetTargetFieldsRequest{\n\t\tTarget: \"database.table\",\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.List": { + "id": "endpoint_modelSync.List", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "search_values": { + "name": "value" + } + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Create": { + "id": "endpoint_modelSync.Create", + "namespace": [ + "subpackage_modelSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + }, + "description": "Values to set as sync target fields." + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + }, + "description": "Conditional value replacement for field mappings." + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:Schedule" + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "id", + "id": "type_:Target" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "mode": "create", + "name": "Users Sync", + "schedule": {}, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"create\",\n \"name\": \"Users Sync\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"object\": \"Users\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.create({\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.create({\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.create({\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.create({\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.create({\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.create({\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetScheduleOptions": { + "id": "endpoint_modelSync.GetScheduleOptions", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/schedules" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ScheduleOptionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/schedules", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "schedule_options": [ + { + "description": "Runs when manually triggered", + "label": "Manual" + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_schedule_options()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getScheduleOptions();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetScheduleOptions(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/schedules", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_schedule_options()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getScheduleOptions();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetScheduleOptions(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/schedules", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_schedule_options()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getScheduleOptions();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetScheduleOptions(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Get": { + "id": "endpoint_modelSync.Get", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Update": { + "id": "endpoint_modelSync.Update", + "namespace": [ + "subpackage_modelSync" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + }, + "description": "Values to set as sync target fields." + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + }, + "description": "Conditional value replacement for field mappings." + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:Schedule" + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "id", + "id": "type_:Target" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "mode": "create", + "name": "Users Sync", + "schedule": {}, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"create\",\n \"name\": \"Users Sync\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"object\": \"Users\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Schedule, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(),\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {},\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{},\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Remove": { + "id": "endpoint_modelSync.Remove", + "namespace": [ + "subpackage_modelSync" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Activate": { + "id": "endpoint_modelSync.Activate", + "namespace": [ + "subpackage_modelSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/activate" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncInput" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Start": { + "id": "endpoint_modelSync.Start", + "namespace": [ + "subpackage_modelSync" + ], + "description": "> 🚧 Force full resync\n>\n> Use caution when setting the `resync` parameter to `true`. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "identities", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "resync", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:StartModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "status": "created" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetStatus": { + "id": "endpoint_modelSync.GetStatus", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SyncStatusEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "current_execution": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + }, + "last_execution": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + }, + "next_execution_time": "2024-01-01T00:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_schemas.Refresh": { + "id": "endpoint_schemas.Refresh", + "namespace": [ + "subpackage_schemas" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/refresh" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/refresh", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/refresh \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.refresh(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.refresh(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Schemas.Refresh(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/refresh", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/schemas/refresh \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.refresh(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.refresh(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Schemas.Refresh(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/refresh", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/schemas/refresh \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.refresh(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.refresh(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Schemas.Refresh(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/refresh", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/schemas/refresh \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.refresh(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.refresh(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Schemas.Refresh(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/refresh", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/schemas/refresh \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.refresh(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.refresh(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Schemas.Refresh(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_schemas.GetStatus": { + "id": "endpoint_schemas.GetStatus", + "namespace": [ + "subpackage_schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncSourceStatusEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "cache_status": "cached", + "last_refresh_finished": "2023-04-25T12:00:00Z", + "last_refresh_started": "2023-04-25T12:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/status \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/status", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/status", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/status", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/status", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/status \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_schemas.Get": { + "id": "endpoint_schemas.Get", + "namespace": [ + "subpackage_schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncSourceSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/public.users", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "public.users" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "fields": [ + { + "id": "email", + "name": "Email", + "remote_type": "varchar(255)", + "type": "string" + } + ], + "id": "contact", + "name": "Contact" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/public.users \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_schemas.GetRecords": { + "id": "endpoint_schemas.GetRecords", + "namespace": [ + "subpackage_schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + }, + { + "type": "literal", + "value": "/records" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SchemaRecordsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/public.users/records", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "public.users" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "data": { + "key": "value" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/public.users/records \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id/records", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id/records \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id/records", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id/records \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id/records", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id/records \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id/records", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id/records \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/schemas/:schema_id/records", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/schemas/:schema_id/records \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"public.users\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"public.users\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Post": { + "id": "endpoint_models.Post", + "namespace": [ + "subpackage_models" + ], + "description": "For a given connection and enrichment configuration, provides the valid sets of input fields.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/enrichment/" + }, + { + "type": "pathParameter", + "value": "connection_id" + }, + { + "type": "literal", + "value": "/inputfields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherConfiguration" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V2GetEnrichmentInputFieldsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields", + "responseStatusCode": 200, + "pathParameters": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + [ + "data" + ] + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.post(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.post(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Post(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.GetEnrichmentInputFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 401, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.post(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.post(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Post(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.GetEnrichmentInputFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 403, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.post(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.post(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Post(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.GetEnrichmentInputFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 404, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.post(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.post(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Post(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.GetEnrichmentInputFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 500, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.post(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.post(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Post(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.GetEnrichmentInputFieldsRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Preview": { + "id": "endpoint_models.Preview", + "namespace": [ + "subpackage_models" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/model-preview" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateModelRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/model-preview", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/model-preview \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.preview(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.preview({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Preview(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsPreviewRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.preview(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.preview({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Preview(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsPreviewRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.preview(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.preview({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Preview(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsPreviewRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.preview(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.preview({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Preview(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsPreviewRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.preview(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.preview({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Preview(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsPreviewRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.List": { + "id": "endpoint_models.List", + "namespace": [ + "subpackage_models" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Create": { + "id": "endpoint_models.Create", + "namespace": [ + "subpackage_models" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/models" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateModelRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/models \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.create({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsCreateRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.create({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsCreateRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.create({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsCreateRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.create({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsCreateRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import CreateModelRequest\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n request=CreateModelRequest(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.create({\n body: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.ModelsCreateRequest{\n\t\tBody: &polytomicgo.CreateModelRequest{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tName: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Get": { + "id": "endpoint_models.Get", + "namespace": [ + "subpackage_models" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Update": { + "id": "endpoint_models.Update", + "namespace": [ + "subpackage_models" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "additional_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelModelFieldRequest" + } + } + } + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelRelation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "async": false + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT \"https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d?async=false\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Remove": { + "id": "endpoint_models.Remove", + "namespace": [ + "subpackage_models" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Sample": { + "id": "endpoint_models.Sample", + "namespace": [ + "subpackage_models" + ], + "description": "Returns sample records from the model. The first ten records that the source provides will be returned after being enriched (if applicable). Synchronous requests must complete within 10s. If either querying or enrichment exceeds 10s, please use the async option.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/sample" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSampleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d/sample", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "records": [ + { + "records": {} + } + ], + "warnings": [ + "Enrichment failed for 4 records: you have ran out of credits" + ] + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d/sample \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_events.List": { + "id": "endpoint_events.List", + "namespace": [ + "subpackage_events" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/events" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "starting_after", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "ending_before", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EventsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/events", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "starting_after": "2020-01-01T00:00:00Z", + "ending_before": "2020-01-01T00:00:00Z" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "created_at": "2024-01-01T00:00:00Z", + "event": { + "key": "value" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "sync.running" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=248df4b7-aa70-47b8-a036-33ac447e668d \\\n --data-urlencode starting_after=2020-01-01T00:00:00Z \\\n --data-urlencode ending_before=2020-01-01T00:00:00Z", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.events.list(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.events.list({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.events.list(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.events.list({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.events.list(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.events.list({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.events.list(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.events.list({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_events.GetTypes": { + "id": "endpoint_events.GetTypes", + "namespace": [ + "subpackage_events" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/events_types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EventTypesEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/events_types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + "data" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/events_types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.events.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.events.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events_types", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/events_types \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.events.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.events.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_jobs.Get": { + "id": "endpoint_jobs.Get", + "namespace": [ + "subpackage_jobs" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/jobs/" + }, + { + "type": "pathParameter", + "value": "type" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:JobResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/jobs/createmodel/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "createmodel" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/createmodel/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_identity.Get": { + "id": "endpoint_identity.Get", + "namespace": [ + "subpackage_identity" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/me" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetIdentityResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/me", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_organization": false, + "is_partner": false, + "is_system": false, + "is_user": true, + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_name": "My Organization", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.identity.get()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.identity.get();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Identity.Get(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.identity.get()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.identity.get();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Identity.Get(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.identity.get()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.identity.get();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Identity.Get(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.List": { + "id": "endpoint_organization.List", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Create": { + "id": "endpoint_organization.Create", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "client_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "client_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Organization" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Organization\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.create({\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.create({\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.create({\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.create({\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Get": { + "id": "endpoint_organization.Get", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Update": { + "id": "endpoint_organization.Update", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "client_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "client_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Organization" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Organization\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Organization\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Organization\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tName: \"My Organization\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Remove": { + "id": "endpoint_organization.Remove", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.List": { + "id": "endpoint_users.List", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListUsersEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.list(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.list(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 404, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.list(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Create": { + "id": "endpoint_users.Create", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "email": "mail@example.com" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"mail@example.com\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 422, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 500, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Get": { + "id": "endpoint_users.Get", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Update": { + "id": "endpoint_users.Update", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "email": "mail@example.com" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"mail@example.com\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Remove": { + "id": "endpoint_users.Remove", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.CreateApiKey": { + "id": "endpoint_users.CreateApiKey", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/keys" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "force", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:APIKeyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d/keys", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "force": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "value": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d/keys?force=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 404, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 500, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.List": { + "id": "endpoint_permissions/policies.List", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListPoliciesResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Create": { + "id": "endpoint_permissions/policies.Create", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Get": { + "id": "endpoint_permissions/policies.Get", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Update": { + "id": "endpoint_permissions/policies.Update", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Remove": { + "id": "endpoint_permissions/policies.Remove", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.policies.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.List": { + "id": "endpoint_permissions/roles.List", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Create": { + "id": "endpoint_permissions/roles.Create", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Get": { + "id": "endpoint_permissions/roles.Get", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Update": { + "id": "endpoint_permissions/roles.Update", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Remove": { + "id": "endpoint_permissions/roles.Remove", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.permissions.roles.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.List": { + "id": "endpoint_modelSync/executions.List", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListExecutionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.list(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.list(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.list(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.Get": { + "id": "endpoint_modelSync/executions.Get", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetExecutionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.GetLogUrls": { + "id": "endpoint_modelSync/executions.GetLogUrls", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "type" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ExecutionLogsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "records" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "expires": "2024-01-01T00:00:00Z", + "urls": [ + "urls" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_log_urls(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogUrls(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 400, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_log_urls(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogUrls(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_log_urls(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogUrls(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_log_urls(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogUrls(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_log_urls(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogUrls(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.GetLogs": { + "id": "endpoint_modelSync/executions.GetLogs", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "type" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "filename" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records/path/to/file.json", + "responseStatusCode": 204, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "records", + "filename": "path/to/file.json" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records/path/to/file.json \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_logs(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n filename=\"path/to/file.json\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogs(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\", \"path/to/file.json\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 400, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_logs(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n filename=\"path/to/file.json\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogs(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\", \"path/to/file.json\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_logs(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n filename=\"path/to/file.json\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogs(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\", \"path/to/file.json\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_logs(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n filename=\"path/to/file.json\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogs(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\", \"path/to/file.json\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get_logs(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"records\",\n filename=\"path/to/file.json\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.modelSync.executions.getLogs(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", \"records\", \"path/to/file.json\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.List": { + "id": "endpoint_webhooks.List", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookListEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Create": { + "id": "endpoint_webhooks.Create", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 6, + "maxLength": 6 + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "endpoint": "https://example.com/webhook", + "secret": "secret" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"https://example.com/webhook\",\n \"secret\": \"secret\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Get": { + "id": "endpoint_webhooks.Get", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Update": { + "id": "endpoint_webhooks.Update", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 6, + "maxLength": 6 + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "endpoint": "https://example.com/webhook", + "secret": "secret" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"https://example.com/webhook\",\n \"secret\": \"secret\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Remove": { + "id": "endpoint_webhooks.Remove", + "namespace": [ + "subpackage_webhooks" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2024-02-08" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2024-02-08\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\" });\nawait polytomic.webhooks.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:ApiError": { + "name": "ApiError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BulkDiscover": { + "name": "BulkDiscover", + "shape": { + "type": "enum", + "values": [ + { + "value": "all" + }, + { + "value": "onlyIncremental" + }, + { + "value": "onlyNonIncremental" + }, + { + "value": "none" + } + ] + } + }, + "type_:BulkExecutionStatus": { + "name": "BulkExecutionStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "scheduled" + }, + { + "value": "running" + }, + { + "value": "exporting" + }, + { + "value": "canceling" + }, + { + "value": "canceled" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "processing" + }, + { + "value": "errors" + } + ] + } + }, + "type_:BulkItemizedSchedule": { + "name": "BulkItemizedSchedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "item", + "valueShape": { + "type": "id", + "id": "type_:BulkSelectiveMode" + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + } + ] + } + }, + "type_:BulkMultiScheduleConfiguration": { + "name": "BulkMultiScheduleConfiguration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schedules", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkItemizedSchedule" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:BulkSchedule": { + "name": "BulkSchedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "day_of_month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_week", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + }, + { + "key": "hour", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "minute", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "multi", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkMultiScheduleConfiguration" + } + } + } + ] + } + }, + "type_:BulkSchemaExecutionStatus": { + "name": "BulkSchemaExecutionStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "scheduled" + }, + { + "value": "running" + }, + { + "value": "exporting" + }, + { + "value": "canceled" + }, + { + "value": "completed" + }, + { + "value": "failed" + } + ] + } + }, + "type_:BulkSelectiveMode": { + "name": "BulkSelectiveMode", + "shape": { + "type": "enum", + "values": [ + { + "value": "none" + }, + { + "value": "incrementalFields" + }, + { + "value": "nonincrementalFields" + } + ] + } + }, + "type_:FilterFieldReferenceType": { + "name": "FilterFieldReferenceType", + "shape": { + "type": "enum", + "values": [ + { + "value": "Model" + }, + { + "value": "Target" + } + ] + } + }, + "type_:FilterFunction": { + "name": "FilterFunction", + "shape": { + "type": "enum", + "values": [ + { + "value": "Equality" + }, + { + "value": "Inequality" + }, + { + "value": "IsNull" + }, + { + "value": "IsNotNull" + }, + { + "value": "True" + }, + { + "value": "False" + }, + { + "value": "OnOrAfter" + }, + { + "value": "OnOrBefore" + }, + { + "value": "GreaterThan" + }, + { + "value": "GreaterThanEqual" + }, + { + "value": "LessThan" + }, + { + "value": "LessThanEqual" + }, + { + "value": "StringContains" + }, + { + "value": "StringEndsWith" + }, + { + "value": "StringDoesNotContain" + }, + { + "value": "StringDoesNotEndWith" + }, + { + "value": "StringOneOf" + }, + { + "value": "StringNotOneOf" + }, + { + "value": "Between" + }, + { + "value": "ArrayContains" + }, + { + "value": "ArrayDoesNotContain" + }, + { + "value": "InTheLast" + }, + { + "value": "StringLike" + }, + { + "value": "StringNotLike" + }, + { + "value": "StringMatchesTrimmed" + } + ] + } + }, + "type_:JsonschemaForm": { + "name": "JsonschemaForm", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:LabelLabel": { + "name": "LabelLabel", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:ModelModelFieldRequest": { + "name": "ModelModelFieldRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "example", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ModelRelation": { + "name": "ModelRelation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "to", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelRelationTo" + } + } + } + ] + } + }, + "type_:ModelRelationTo": { + "name": "ModelRelationTo", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:RestErrResponse": { + "name": "RestErrResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Application-specific error code." + }, + { + "key": "context", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Application context." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Status text." + } + ] + } + }, + "type_:ScheduleFrequency": { + "name": "ScheduleFrequency", + "shape": { + "type": "enum", + "values": [ + { + "value": "manual" + }, + { + "value": "continuous" + }, + { + "value": "hourly" + }, + { + "value": "daily" + }, + { + "value": "weekly" + }, + { + "value": "custom" + }, + { + "value": "builder" + }, + { + "value": "runafter" + }, + { + "value": "multi" + }, + { + "value": "dbtcloud" + } + ] + } + }, + "type_:ScheduleScheduleOption": { + "name": "ScheduleScheduleOption", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JsonschemaForm" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:SchemaAssociation": { + "name": "SchemaAssociation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "reference_to", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "referenced_field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:SchemaIdentityFunction": { + "name": "SchemaIdentityFunction", + "shape": { + "type": "enum", + "values": [ + { + "value": "Equality" + }, + { + "value": "ISubstring" + }, + { + "value": "OneOf" + } + ] + } + }, + "type_:SyncDestinationProperties": { + "name": "SyncDestinationProperties", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "does_not_report_operation_counts", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "new_target_label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "optional_target_mappings", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "primary_metadata_object", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_creation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_type_selection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target_creator", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "use_field_names_as_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ExecutionStatus": { + "name": "ExecutionStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "scheduled" + }, + { + "value": "queued" + }, + { + "value": "waiting" + }, + { + "value": "running" + }, + { + "value": "processing" + }, + { + "value": "canceling" + }, + { + "value": "canceled" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "interrupted" + } + ] + } + }, + "type_:APIKeyResponse": { + "name": "APIKeyResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:APIKeyResponseEnvelope": { + "name": "APIKeyResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:APIKeyResponse" + } + } + } + ] + } + }, + "type_:ActivateSyncEnvelope": { + "name": "ActivateSyncEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ActivateSyncOutput" + } + } + } + ] + } + }, + "type_:ActivateSyncInput": { + "name": "ActivateSyncInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + ] + } + }, + "type_:ActivateSyncOutput": { + "name": "ActivateSyncOutput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncDest": { + "name": "BulkSyncDest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "modes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SupportedMode" + } + } + } + } + ] + } + }, + "type_:BulkSyncDestEnvelope": { + "name": "BulkSyncDestEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncDest" + } + } + } + ] + } + }, + "type_:BulkSyncListEnvelope": { + "name": "BulkSyncListEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSyncResponse" + } + } + } + } + ] + } + }, + "type_:BulkSyncResponse": { + "name": "BulkSyncResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchedule" + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncResponseEnvelope": { + "name": "BulkSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncResponse" + } + } + } + ] + } + }, + "type_:ConfigurationValue": { + "name": "ConfigurationValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ConnectionListResponseEnvelope": { + "name": "ConnectionListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionResponseSchema" + } + } + } + } + ] + } + }, + "type_:ConnectionMeta": { + "name": "ConnectionMeta", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "has_items", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ConnectionMetaResponse": { + "name": "ConnectionMetaResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:ConfigurationValue" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionMeta" + } + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ConnectionParameterValue": { + "name": "ConnectionParameterValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:ConnectionParameterValuesResp": { + "name": "ConnectionParameterValuesResp", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "allows_creation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "values", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionParameterValue" + } + } + } + } + ] + } + }, + "type_:ConnectionParameterValuesResponseEnvelope": { + "name": "ConnectionParameterValuesResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionParameterValuesResp" + } + } + } + } + } + ] + } + }, + "type_:ConnectionResponseEnvelope": { + "name": "ConnectionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionResponseSchema" + } + } + } + ] + } + }, + "type_:ConnectionResponseSchema": { + "name": "ConnectionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "api_calls_last_24_hours", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "API calls made to service in the last 24h (supported integrations only)." + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status_error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionTypeSchema" + } + } + } + ] + } + }, + "type_:ConnectionType": { + "name": "ConnectionType", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "envConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "use_oauth", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ConnectionTypeResponseEnvelope": { + "name": "ConnectionTypeResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionType" + } + } + } + } + ] + } + }, + "type_:ConnectionTypeSchema": { + "name": "ConnectionTypeSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "operations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:CreateConnectionResponseEnvelope": { + "name": "CreateConnectionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CreateConnectionResponseSchema" + } + } + } + ] + } + }, + "type_:CreateConnectionResponseSchema": { + "name": "CreateConnectionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "auth_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code to enter in order to complete connection authentication." + }, + { + "key": "auth_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL to visit to complete connection authentication." + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status_error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionTypeSchema" + } + } + } + ] + } + }, + "type_:CreateModelRequest": { + "name": "CreateModelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "additional_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelModelFieldRequest" + } + } + } + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelRelation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:V2EnricherConfiguration": { + "name": "V2EnricherConfiguration", + "description": "Similar to a model configuration, this configures the enricher. For example, if you wanted to use Apollo to enrich people, you would send `{\"object\": \"people\"}` as the configuration. Each enricher configuration can be found in the connection configuration docs.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:V2EnricherMapping": { + "name": "V2EnricherMapping", + "description": "A map of parent model Source Name to child model Source Name. For example, if your model has a field called `work_email` and the enricher accepts a field called `email`, you'd send a map of `{\"work_email\":\"email\"}`. The set of required input mappings varies based on the configuration of the enrichment. You can use the `enrichment/{connection_id}/inputfields` API to discover available input field combinations for a given configuration.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "type_:Enrichment": { + "name": "Enrichment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherConfiguration" + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "enricher_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Must be provided to update an existing enrichment" + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + }, + "description": "If not provided, all fields will be enabled." + }, + { + "key": "mappings", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherMapping" + } + } + } + ] + } + }, + "type_:Event": { + "name": "Event", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "event", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:EventTypesEnvelope": { + "name": "EventTypesEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:EventsEnvelope": { + "name": "EventsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Event" + } + } + } + } + ] + } + }, + "type_:ExecutionCounts": { + "name": "ExecutionCounts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "insert", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "update", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:ExecutionLogResponse": { + "name": "ExecutionLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "expires", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ExecutionLogsResponseEnvelope": { + "name": "ExecutionLogsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionLogResponse" + } + } + } + ] + } + }, + "type_:Filter": { + "name": "Filter", + "description": "Either `field` or `field_id` must be provided. If `field` is provided, `field_id` is ignored.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Source" + } + } + }, + { + "key": "field_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model or Target field name to filter on." + }, + { + "key": "field_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilterFieldReferenceType" + } + } + }, + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:FilterFunction" + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:GetConnectionMetaEnvelope": { + "name": "GetConnectionMetaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionMetaResponse" + } + } + } + ] + } + }, + "type_:V2GetEnrichmentInputFieldsResponseEnvelope": { + "name": "V2GetEnrichmentInputFieldsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "type_:GetExecutionResponseEnvelope": { + "name": "GetExecutionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + } + ] + } + }, + "type_:GetExecutionResponseSchema": { + "name": "GetExecutionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "counts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionCounts" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "errors", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "started_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:GetIdentityResponseEnvelope": { + "name": "GetIdentityResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetIdentityResponseSchema" + } + } + } + ] + } + }, + "type_:GetIdentityResponseSchema": { + "name": "GetIdentityResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "is_organization", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_partner", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Identity": { + "name": "Identity", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:SchemaIdentityFunction" + } + }, + { + "key": "new_field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "remote_field_type_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:IdentityFunction": { + "name": "IdentityFunction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:JobResponse": { + "name": "JobResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WorkTaskStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:JobResponseEnvelope": { + "name": "JobResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:ListExecutionResponseEnvelope": { + "name": "ListExecutionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + } + } + ] + } + }, + "type_:ListPoliciesResponseEnvelope": { + "name": "ListPoliciesResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyResponse" + } + } + } + } + ] + } + }, + "type_:ListModelSyncResponseEnvelope": { + "name": "ListModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncResponse" + } + } + } + } + ] + } + }, + "type_:ListUsersEnvelope": { + "name": "ListUsersEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:User" + } + } + } + } + ] + } + }, + "type_:Mode": { + "name": "Mode", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelField": { + "name": "ModelField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "example", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "remote_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "unique", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "user_added", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelFieldResponse": { + "name": "ModelFieldResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + } + } + ] + } + }, + "type_:ModelListResponseEnvelope": { + "name": "ModelListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelResponse" + } + } + } + } + ] + } + }, + "type_:ModelResponse": { + "name": "ModelResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LabelLabel" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Relation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:ModelResponseEnvelope": { + "name": "ModelResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelResponse" + } + } + }, + { + "key": "job", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:ModelSample": { + "name": "ModelSample", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:V2SampleRecord" + } + } + } + }, + { + "key": "warnings", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ModelSampleResponseEnvelope": { + "name": "ModelSampleResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelSample" + } + } + }, + { + "key": "job", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:Organization": { + "name": "Organization", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:OrganizationEnvelope": { + "name": "OrganizationEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Organization" + } + } + } + ] + } + }, + "type_:OrganizationsEnvelope": { + "name": "OrganizationsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Organization" + } + } + } + } + ] + } + }, + "type_:Override": { + "name": "Override", + "description": "Either `field` or `field_id` must be provided. If `field_id` is provided, `field` is ignored.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Source" + } + } + }, + { + "key": "field_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Field ID of the model field to override." + }, + { + "key": "function", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilterFunction" + } + } + }, + { + "key": "override", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:PolicyAction": { + "name": "PolicyAction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "action", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:PolicyResponse": { + "name": "PolicyResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + }, + { + "key": "system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:PolicyResponseEnvelope": { + "name": "PolicyResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PolicyResponse" + } + } + } + ] + } + }, + "type_:Relation": { + "name": "Relation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "to", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RelationTo" + } + } + } + ] + } + }, + "type_:RelationTo": { + "name": "RelationTo", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:RoleListResponseEnvelope": { + "name": "RoleListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RoleResponse" + } + } + } + } + ] + } + }, + "type_:RoleResponse": { + "name": "RoleResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:RoleResponseEnvelope": { + "name": "RoleResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RoleResponse" + } + } + } + ] + } + }, + "type_:RunAfter": { + "name": "RunAfter", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bulk_sync_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "sync_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:V2SampleRecord": { + "name": "V2SampleRecord", + "description": "A map of `fieldSource` -> `fieldName: fieldValue`. Because there may be field name conflicts between the base model and enrichments, the base model fields are placed in a map under the model ID. Fields from enrichments are placed under the enricher ID.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + }, + "type_:Schedule": { + "name": "Schedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_week", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + } + }, + { + "key": "hour", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "minute", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "run_after", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RunAfter" + } + } + } + ] + } + }, + "type_:ScheduleOptionResponse": { + "name": "ScheduleOptionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schedule_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ScheduleScheduleOption" + } + } + } + } + ] + } + }, + "type_:ScheduleOptionResponseEnvelope": { + "name": "ScheduleOptionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleOptionResponse" + } + } + } + ] + } + }, + "type_:Source": { + "name": "Source", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:StartModelSyncResponseEnvelope": { + "name": "StartModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StartModelSyncResponseSchema" + } + } + } + ] + } + }, + "type_:StartModelSyncResponseSchema": { + "name": "StartModelSyncResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionStatus" + } + } + } + ] + } + }, + "type_:SupportedMode": { + "name": "SupportedMode", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelSyncField": { + "name": "ModelSyncField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "new", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "override_value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ModelSyncResponse": { + "name": "ModelSyncResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Schedule" + } + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Target" + } + } + } + ] + } + }, + "type_:ModelSyncResponseEnvelope": { + "name": "ModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelSyncResponse" + } + } + } + ] + } + }, + "type_:SyncStatusEnvelope": { + "name": "SyncStatusEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SyncStatusResponse" + } + } + } + ] + } + }, + "type_:SyncStatusResponse": { + "name": "SyncStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "current_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + }, + { + "key": "last_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + }, + { + "key": "next_execution_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:Target": { + "name": "Target", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "new_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "object", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "search_values", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + ] + } + }, + "type_:TargetField": { + "name": "TargetField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "association", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "createable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filterable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identity_functions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:IdentityFunction" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "required", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "source_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "supports_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "updateable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:TargetResponse": { + "name": "TargetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TargetField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "modes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Mode" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "properties", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SyncDestinationProperties" + } + } + }, + { + "key": "refreshed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:TargetResponseEnvelope": { + "name": "TargetResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TargetResponse" + } + } + } + ] + } + }, + "type_:User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:UserEnvelope": { + "name": "UserEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:User" + } + } + } + ] + } + }, + "type_:Webhook": { + "name": "Webhook", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:WebhookEnvelope": { + "name": "WebhookEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Webhook" + } + } + } + ] + } + }, + "type_:WebhookListEnvelope": { + "name": "WebhookListEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Webhook" + } + } + } + } + ] + } + }, + "type_:BulkField": { + "name": "BulkField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "obfuscated", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:BulkSchema": { + "name": "BulkSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "output_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "partition_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSchemaEnvelope": { + "name": "BulkSchemaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + ] + } + }, + "type_:BulkSyncExecution": { + "name": "BulkSyncExecution", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "is_resync", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_test", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSyncSchemaExecution" + } + } + } + }, + { + "key": "started_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkExecutionStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncExecutionEnvelope": { + "name": "BulkSyncExecutionEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + } + ] + } + }, + "type_:BulkSyncSchemaExecution": { + "name": "BulkSyncSchemaExecution", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "error_count", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "record_count", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "schema", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "started_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchemaExecutionStatus" + } + } + }, + { + "key": "status_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncSource": { + "name": "BulkSyncSource", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Schema" + } + } + } + } + ] + } + }, + "type_:BulkSyncSourceEnvelope": { + "name": "BulkSyncSourceEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncSource" + } + } + } + ] + } + }, + "type_:BulkSyncSourceSchemaEnvelope": { + "name": "BulkSyncSourceSchemaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Schema" + } + } + } + ] + } + }, + "type_:BulkSyncSourceStatus": { + "name": "BulkSyncSourceStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cache_status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last_refresh_finished", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "last_refresh_started", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:BulkSyncSourceStatusEnvelope": { + "name": "BulkSyncSourceStatusEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncSourceStatus" + } + } + } + ] + } + }, + "type_:BulkSyncStatusEnvelope": { + "name": "BulkSyncStatusEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncStatusResponse" + } + } + } + ] + } + }, + "type_:BulkSyncStatusResponse": { + "name": "BulkSyncStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "current_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + }, + { + "key": "last_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + }, + { + "key": "next_execution_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:ConnectCardResponse": { + "name": "ConnectCardResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "redirect_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ConnectCardResponseEnvelope": { + "name": "ConnectCardResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectCardResponse" + } + } + } + ] + } + }, + "type_:ListBulkSchema": { + "name": "ListBulkSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + } + ] + } + }, + "type_:ListBulkSyncExecutionsEnvelope": { + "name": "ListBulkSyncExecutionsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + } + } + ] + } + }, + "type_:PickValue": { + "name": "PickValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Schema": { + "name": "Schema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SchemaField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:SchemaField": { + "name": "SchemaField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "association", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SchemaAssociation" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "remote_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "values", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PickValue" + } + } + } + } + ] + } + }, + "type_:SchemaRecordsResponseEnvelope": { + "name": "SchemaRecordsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + } + ] + } + }, + "type_:GetModelSyncSourceMetaEnvelope": { + "name": "GetModelSyncSourceMetaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelSyncSourceMetaResponse" + } + } + } + ] + } + }, + "type_:SourceMeta": { + "name": "SourceMeta", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "has_items", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ModelSyncSourceMetaResponse": { + "name": "ModelSyncSourceMetaResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:ConfigurationValue" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SourceMeta" + } + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:WorkTaskStatus": { + "name": "WorkTaskStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "running" + }, + { + "value": "done" + }, + { + "value": "failed" + } + ] + } + } + }, + "subpackages": { + "subpackage_bulkSync": { + "id": "subpackage_bulkSync", + "name": "bulkSync" + }, + "subpackage_bulkSync/executions": { + "id": "subpackage_bulkSync/executions", + "name": "executions" + }, + "subpackage_bulkSync/schemas": { + "id": "subpackage_bulkSync/schemas", + "name": "schemas" + }, + "subpackage_connections": { + "id": "subpackage_connections", + "name": "connections" + }, + "subpackage_modelSync": { + "id": "subpackage_modelSync", + "name": "modelSync" + }, + "subpackage_schemas": { + "id": "subpackage_schemas", + "name": "schemas" + }, + "subpackage_models": { + "id": "subpackage_models", + "name": "models" + }, + "subpackage_events": { + "id": "subpackage_events", + "name": "events" + }, + "subpackage_jobs": { + "id": "subpackage_jobs", + "name": "jobs" + }, + "subpackage_identity": { + "id": "subpackage_identity", + "name": "identity" + }, + "subpackage_organization": { + "id": "subpackage_organization", + "name": "organization" + }, + "subpackage_users": { + "id": "subpackage_users", + "name": "users" + }, + "subpackage_permissions": { + "id": "subpackage_permissions", + "name": "permissions" + }, + "subpackage_permissions/policies": { + "id": "subpackage_permissions/policies", + "name": "policies" + }, + "subpackage_permissions/roles": { + "id": "subpackage_permissions/roles", + "name": "roles" + }, + "subpackage_modelSync/executions": { + "id": "subpackage_modelSync/executions", + "name": "executions" + }, + "subpackage_webhooks": { + "id": "subpackage_webhooks", + "name": "webhooks" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "token" + } + }, + "globalHeaders": [ + { + "key": "X-Polytomic-Version", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "2024-02-08" + } + } + } + ] + }, + { + "id": "4f9d4e39-a928-4c8a-b9d0-308434722f10", + "endpoints": { + "endpoint_bulkSync.GetDestination": { + "id": "endpoint_bulkSync.GetDestination", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/dest/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncDestEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/dest/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "advanced": { + "items": { + "truncate_existing": { + "default": "", + "required": false + } + } + }, + "mirror_schemas": { + "default": "", + "required": false + }, + "schema": { + "default": "", + "required": false + } + }, + "modes": [ + { + "description": "Replace all records", + "id": "replace", + "label": "Replace", + "requires_identity": false, + "supports_field_sync_mode": false, + "supports_target_filters": false + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/dest/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/dest/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_destination(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getDestination(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetDestination(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetSource": { + "id": "endpoint_bulkSync.GetSource", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/source/" + }, + { + "type": "pathParameter", + "value": "connection_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "include_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncSourceEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "include_fields": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "key": "value" + }, + "schemas": [ + { + "id": "contact", + "name": "Contact" + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id", + "responseStatusCode": 400, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": { + "refresh_schemas": true, + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:connection_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id", + "responseStatusCode": 401, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": { + "refresh_schemas": true, + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:connection_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id", + "responseStatusCode": 404, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": { + "refresh_schemas": true, + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:connection_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id", + "responseStatusCode": 500, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": { + "refresh_schemas": true, + "include_fields": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/source/:connection_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true \\\n -d include_fields=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n include_fields=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n include_fields: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetSourceRequest{\n\t\tIncludeFields: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetSourceSchema": { + "id": "endpoint_bulkSync.GetSourceSchema", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/source/" + }, + { + "type": "pathParameter", + "value": "connection_id" + }, + { + "type": "literal", + "value": "/schema/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncSourceSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d/schema/schema_id", + "responseStatusCode": 200, + "pathParameters": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "schema_id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "fields": [ + { + "id": "email", + "name": "Email", + "remote_type": "varchar(255)", + "type": "string" + } + ], + "id": "contact", + "name": "Contact" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d/schema/schema_id \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_schema(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"schema_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceSchema(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"schema_id\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceSchema(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"schema_id\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/schema/:schema_id", + "responseStatusCode": 400, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/schema/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_schema(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"schema_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceSchema(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"schema_id\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceSchema(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"schema_id\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/schema/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/schema/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_schema(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"schema_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceSchema(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"schema_id\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceSchema(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"schema_id\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/schema/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/schema/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_schema(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"schema_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceSchema(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"schema_id\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceSchema(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"schema_id\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/schema/:schema_id", + "responseStatusCode": 500, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/schema/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_schema(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"schema_id\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceSchema(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"schema_id\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceSchema(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"schema_id\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetSourceStatus": { + "id": "endpoint_bulkSync.GetSourceStatus", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/source/" + }, + { + "type": "pathParameter", + "value": "connection_id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncSourceStatusEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d/status", + "responseStatusCode": 200, + "pathParameters": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "cache_status": "cached", + "last_refresh_finished": "2023-04-25T12:00:00Z", + "last_refresh_started": "2023-04-25T12:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d/status \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_status(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/status", + "responseStatusCode": 400, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_status(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/status", + "responseStatusCode": 401, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_status(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/status", + "responseStatusCode": 404, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_status(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/source/:connection_id/status", + "responseStatusCode": 500, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/source/:connection_id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_source_status(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getSourceStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetSourceStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.List": { + "id": "endpoint_bulkSync.List", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncListEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1" + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Create": { + "id": "endpoint_bulkSync.Create", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "automatically_add_new_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "automatically_add_new_objects", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "disable_record_timestamps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead" + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Bulk Sync", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"My Bulk Sync\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.create(\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.create({\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Get": { + "id": "endpoint_bulkSync.Get", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d refresh_schemas=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncGetRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Remove": { + "id": "endpoint_bulkSync.Remove", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "refresh_schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d?refresh_schemas=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "refresh_schemas": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/bulk/syncs/:id?refresh_schemas=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh_schemas=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh_schemas: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.BulkSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.BulkSyncRemoveRequest{\n\t\tRefreshSchemas: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Update": { + "id": "endpoint_bulkSync.Update", + "namespace": [ + "subpackage_bulkSync" + ], + "description": "> 📘 Updating schemas\n>\n> Schema updates can be performed using the [Update Bulk Sync Schemas](https://apidocs.polytomic.com/api-reference/bulk-sync/schemas/patch) endpoint.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "automatically_add_new_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "automatically_add_new_objects", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkDiscover" + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "disable_record_timestamps", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead" + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Bulk Sync", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "destination_configuration": { + "schema": "my_schema" + }, + "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "discover": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "mode": "replace", + "name": "My Bulk Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "frequency": "manual", + "day_of_month": "1", + "day_of_week": "monday", + "hour": "0", + "minute": "0", + "month": "1", + "multi": { + "type": "type" + } + }, + "source_configuration": { + "replication_slot": "slot" + }, + "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"My Bulk Sync\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "destination_connection_id": "string", + "name": "string", + "schedule": { + "frequency": "manual" + }, + "source_connection_id": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destination_connection_id\": \"string\",\n \"name\": \"string\",\n \"schedule\": {\n \"frequency\": \"manual\"\n },\n \"source_connection_id\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import BulkSchedule, ScheduleFrequency\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n destination_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"name\",\n schedule=BulkSchedule(\n frequency=ScheduleFrequency.MANUAL,\n ),\n source_connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient, Polytomic } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n destination_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name: \"name\",\n schedule: {\n frequency: Polytomic.ScheduleFrequency.Manual\n },\n source_connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateBulkSyncRequest{\n\t\tDestinationConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tMode: polytomicgo.String(\n\t\t\t\"replicate\",\n\t\t),\n\t\tName: \"My Bulk Sync\",\n\t\tSchedule: &polytomicgo.BulkSchedule{\n\t\t\tDayOfMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t\tDayOfWeek: polytomicgo.String(\n\t\t\t\t\"monday\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.ScheduleFrequencyManual,\n\t\t\tHour: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMinute: polytomicgo.String(\n\t\t\t\t\"0\",\n\t\t\t),\n\t\t\tMonth: polytomicgo.String(\n\t\t\t\t\"1\",\n\t\t\t),\n\t\t},\n\t\tSourceConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Activate": { + "id": "endpoint_bulkSync.Activate", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/activate" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncInput" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/activate", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.Start": { + "id": "endpoint_bulkSync.Start", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "resync", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "test", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncExecutionEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n resync=False,\n test=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n resync: false,\n test: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartBulkSyncRequest{\n\t\tResync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTest: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n resync=False,\n test=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n resync: false,\n test: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartBulkSyncRequest{\n\t\tResync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTest: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n resync=False,\n test=False,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n resync: false,\n test: false\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartBulkSyncRequest{\n\t\tResync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTest: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync.GetStatus": { + "id": "endpoint_bulkSync.GetStatus", + "namespace": [ + "subpackage_bulkSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncStatusEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "current_execution": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + }, + "last_execution": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + }, + "next_execution_time": "2023-04-25T12:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/status", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/status", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/status", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/executions.List": { + "id": "endpoint_bulkSync/executions.List", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSyncExecutionsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/executions.Get": { + "id": "endpoint_bulkSync/executions.Get", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "exec_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "exec_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSyncExecutionEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "exec_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "completed_at": "2023-04-25T12:00:00Z", + "created_at": "2023-04-25T12:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_resync": false, + "is_test": false, + "schemas": [ + { + "error_count": 0, + "record_count": 1000, + "schema": "contact" + } + ], + "started_at": "2023-04-25T12:00:00Z", + "status": "created", + "type": "scheduled" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n exec_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions/:exec_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "exec_id": ":exec_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions/:exec_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n exec_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/executions/:exec_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "exec_id": ":exec_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/executions/:exec_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.executions.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n exec_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.List": { + "id": "endpoint_bulkSync/schemas.List", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSchema" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.SchemasListRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "filters": { + "string": "string" + } + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode filters={\"string\":\"string\"}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.SchemasListRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "filters": { + "string": "string" + } + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n --data-urlencode filters={\"string\":\"string\"}", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.list(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.SchemasListRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Patch": { + "id": "endpoint_bulkSync/schemas.Patch", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListBulkSchema" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Patch(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&bulksync.BulkSyncSchemasRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Get": { + "id": "endpoint_bulkSync/schemas.Get", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/Contact", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "Contact" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/Contact \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"Contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"Contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"Contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"Contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"Contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"Contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"Contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"Contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"Contact\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_bulkSync/schemas.Update": { + "id": "endpoint_bulkSync/schemas.Update", + "namespace": [ + "subpackage_bulkSync", + "subpackage_bulkSync/schemas" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/bulk/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/schemas/" + }, + { + "type": "pathParameter", + "value": "schema_id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkField" + } + } + } + }, + { + "key": "partition_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:BulkSchemaEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "contact" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "enabled": true, + "fields": [ + { + "enabled": true, + "id": "email", + "obfuscated": false + } + ], + "id": "Contact", + "output_name": "contact", + "partition_key": "email" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n enabled=True,\n partition_key=\"email\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {\n enabled: true,\n partition_key: \"email\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{\n\t\tEnabled: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t\tPartitionKey: polytomicgo.String(\n\t\t\t\"email\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n enabled=True,\n partition_key=\"email\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {\n enabled: true,\n partition_key: \"email\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{\n\t\tEnabled: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t\tPartitionKey: polytomicgo.String(\n\t\t\t\"email\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n enabled=True,\n partition_key=\"email\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {\n enabled: true,\n partition_key: \"email\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{\n\t\tEnabled: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t\tPartitionKey: polytomicgo.String(\n\t\t\t\"email\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n enabled=True,\n partition_key=\"email\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {\n enabled: true,\n partition_key: \"email\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{\n\t\tEnabled: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t\tPartitionKey: polytomicgo.String(\n\t\t\t\"email\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/bulk/syncs/:id/schemas/:schema_id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.bulk_sync.schemas.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n enabled=True,\n partition_key=\"email\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.bulkSync.schemas.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\", {\n enabled: true,\n partition_key: \"email\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tbulksync \"github.com/polytomic/polytomic-go/bulksync\"\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.BulkSync.Schemas.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n\t&bulksync.UpdateBulkSchema{\n\t\tEnabled: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t\tPartitionKey: polytomicgo.String(\n\t\t\t\"email\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetTypes": { + "id": "endpoint_connections.GetTypes", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connection_types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionTypeResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connection_types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "envConfig": { + "key": "value" + }, + "id": "postgresql", + "name": "PostgreSQL", + "use_oauth": true + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connection_types", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connection_types", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connection_types \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.List": { + "id": "endpoint_connections.List", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "api_calls_last_24_hours": 2021, + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Create": { + "id": "endpoint_connections.Create", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "redirect_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL to redirect to after completing OAuth flow." + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "validate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Validate connection configuration." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Postgres Connection", + "type": "postgresql" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "auth_code": "auth_code", + "auth_url": "auth_url", + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Postgres Connection\",\n \"type\": \"postgresql\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Connection\",\n redirect_url=\"https://example.com/oauth_redirect\",\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.create({\n name: \"My Connection\",\n redirect_url: \"https://example.com/oauth_redirect\",\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tRedirectUrl: polytomicgo.String(\n\t\t\t\"https://example.com/oauth_redirect\",\n\t\t),\n\t\tType: \"postgresql\",\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Connection\",\n redirect_url=\"https://example.com/oauth_redirect\",\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.create({\n name: \"My Connection\",\n redirect_url: \"https://example.com/oauth_redirect\",\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tRedirectUrl: polytomicgo.String(\n\t\t\t\"https://example.com/oauth_redirect\",\n\t\t),\n\t\tType: \"postgresql\",\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Connection\",\n redirect_url=\"https://example.com/oauth_redirect\",\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.create({\n name: \"My Connection\",\n redirect_url: \"https://example.com/oauth_redirect\",\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tRedirectUrl: polytomicgo.String(\n\t\t\t\"https://example.com/oauth_redirect\",\n\t\t),\n\t\tType: \"postgresql\",\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Connection\",\n redirect_url=\"https://example.com/oauth_redirect\",\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.create({\n name: \"My Connection\",\n redirect_url: \"https://example.com/oauth_redirect\",\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tRedirectUrl: polytomicgo.String(\n\t\t\t\"https://example.com/oauth_redirect\",\n\t\t),\n\t\tType: \"postgresql\",\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Connection\",\n redirect_url=\"https://example.com/oauth_redirect\",\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.create({\n name: \"My Connection\",\n redirect_url: \"https://example.com/oauth_redirect\",\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tRedirectUrl: polytomicgo.String(\n\t\t\t\"https://example.com/oauth_redirect\",\n\t\t),\n\t\tType: \"postgresql\",\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "type": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"type\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.create(\n name=\"My Connection\",\n redirect_url=\"https://example.com/oauth_redirect\",\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.create({\n name: \"My Connection\",\n redirect_url: \"https://example.com/oauth_redirect\",\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tRedirectUrl: polytomicgo.String(\n\t\t\t\"https://example.com/oauth_redirect\",\n\t\t),\n\t\tType: \"postgresql\",\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Connect": { + "id": "endpoint_connections.Connect", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections/connect/" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "connection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "redirect_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "whitelist", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectCardResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/connect/", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Salesforce Connection", + "redirect_url": "redirect_url" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "redirect_url": "https://example.com", + "token": "token" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Salesforce Connection\",\n \"redirect_url\": \"redirect_url\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/connect/", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string", + "redirect_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/connect/ \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"redirect_url\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Get": { + "id": "endpoint_connections.Get", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "api_calls_last_24_hours": 2021, + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Remove": { + "id": "endpoint_connections.Remove", + "namespace": [ + "subpackage_connections" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "force", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "force": true + }, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d?force=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/connections/:id?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Connections.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsRemoveRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.Update": { + "id": "endpoint_connections.Update", + "namespace": [ + "subpackage_connections" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "reconnect", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "validate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Validate connection configuration." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateConnectionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Postgres Connection" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "auth_code": "auth_code", + "auth_url": "auth_url", + "configuration": { + "database": "example", + "hostname": "postgres.example.com", + "password": "password", + "port": 5432, + "username": "user" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "My Postgres Connection", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "status": "healthy", + "status_error": "error message", + "type": { + "id": "postgresql", + "name": "PostgreSQL", + "operations": [ + "operations" + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Postgres Connection\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Connection\",\n reconnect=False,\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Connection\",\n reconnect: false,\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tReconnect: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tType: polytomicgo.String(\n\t\t\t\"postgresql\",\n\t\t),\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Connection\",\n reconnect=False,\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Connection\",\n reconnect: false,\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tReconnect: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tType: polytomicgo.String(\n\t\t\t\"postgresql\",\n\t\t),\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Connection\",\n reconnect=False,\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Connection\",\n reconnect: false,\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tReconnect: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tType: polytomicgo.String(\n\t\t\t\"postgresql\",\n\t\t),\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Connection\",\n reconnect=False,\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Connection\",\n reconnect: false,\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tReconnect: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tType: polytomicgo.String(\n\t\t\t\"postgresql\",\n\t\t),\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Connection\",\n reconnect=False,\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Connection\",\n reconnect: false,\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tReconnect: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tType: polytomicgo.String(\n\t\t\t\"postgresql\",\n\t\t),\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Connection\",\n reconnect=False,\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Connection\",\n reconnect: false,\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tReconnect: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tType: polytomicgo.String(\n\t\t\t\"postgresql\",\n\t\t),\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/connections/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"My Connection\",\n reconnect=False,\n type=\"s3\",\n validate=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"My Connection\",\n reconnect: false,\n type: \"s3\",\n validate: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateConnectionRequestSchema{\n\t\tName: \"My Postgres Connection\",\n\t\tReconnect: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tType: polytomicgo.String(\n\t\t\t\"postgresql\",\n\t\t),\n\t\tValidate: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetParameterValues": { + "id": "endpoint_connections.GetParameterValues", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/parameter_values" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ConnectionParameterValuesResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/parameter_values", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "data": { + "allows_creation": true, + "values": [ + {} + ] + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/parameter_values \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/parameter_values", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/parameter_values \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_parameter_values(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getParameterValues(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetParameterValues(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetSource": { + "id": "endpoint_connections.GetSource", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/source" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetConnectionMetaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "configuration": {} + }, + "items": { + "items": { + "has_items": true + } + }, + "requires_one_of": [ + "requires_one_of" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:id/source \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSource(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSource(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetSourceFields": { + "id": "endpoint_connections.GetSourceFields", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/source/fields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "query", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelFieldResponse" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source/fields", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "description": "Unique identifier", + "example": { + "key": "value" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source/fields \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelFieldsRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/source/fields", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/source/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_source_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getSourceFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetSourceFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ModelFieldsRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetTarget": { + "id": "endpoint_connections.GetTarget", + "namespace": [ + "subpackage_connections" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/target" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "search", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetConnectionMetaEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "type": "table", + "search": "public.users" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "configuration": {} + }, + "items": { + "items": { + "has_items": true + } + }, + "requires_one_of": [ + "requires_one_of" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target \\\n -H \"Authorization: Bearer \" \\\n -d type=table \\\n -d search=public.users", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"table\",\n search=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n type: \"table\",\n search: \"public.users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsGetTargetRequest{\n\t\tType: polytomicgo.String(\n\t\t\t\"table\",\n\t\t),\n\t\tSearch: polytomicgo.String(\n\t\t\t\"public.users\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"table\",\n search=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n type: \"table\",\n search: \"public.users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsGetTargetRequest{\n\t\tType: polytomicgo.String(\n\t\t\t\"table\",\n\t\t),\n\t\tSearch: polytomicgo.String(\n\t\t\t\"public.users\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"table\",\n search=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n type: \"table\",\n search: \"public.users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsGetTargetRequest{\n\t\tType: polytomicgo.String(\n\t\t\t\"table\",\n\t\t),\n\t\tSearch: polytomicgo.String(\n\t\t\t\"public.users\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"table\",\n search=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n type: \"table\",\n search: \"public.users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsGetTargetRequest{\n\t\tType: polytomicgo.String(\n\t\t\t\"table\",\n\t\t),\n\t\tSearch: polytomicgo.String(\n\t\t\t\"public.users\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"table\",\n search=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n type: \"table\",\n search: \"public.users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsGetTargetRequest{\n\t\tType: polytomicgo.String(\n\t\t\t\"table\",\n\t\t),\n\t\tSearch: polytomicgo.String(\n\t\t\t\"public.users\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "type": "string", + "search": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/connections/:id/target \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d type=string \\\n -d search=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"table\",\n search=\"public.users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTarget(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n type: \"table\",\n search: \"public.users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTarget(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ConnectionsGetTargetRequest{\n\t\tType: polytomicgo.String(\n\t\t\t\"table\",\n\t\t),\n\t\tSearch: polytomicgo.String(\n\t\t\t\"public.users\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_connections.GetTargetFields": { + "id": "endpoint_connections.GetTargetFields", + "namespace": [ + "subpackage_connections" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/target/fields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "refresh", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:TargetResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target/fields", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "target": "database.table" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "fields": [ + { + "association": false, + "createable": true, + "description": "Field description", + "filterable": true, + "id": "field1", + "name": "Field", + "required": true, + "source_type": "string", + "supports_identity": false, + "type": "string", + "updateable": true + } + ], + "id": "database.table", + "modes": [ + { + "description": "Create records when they don't exist; don't update existing ones", + "label": "Create", + "mode": "create", + "requires_identity": true, + "supports_field_sync_mode": false, + "supports_target_filters": false + } + ], + "name": "Table", + "properties": { + "does_not_report_operation_counts": true, + "new_target_label": "new_target_label", + "optional_target_mappings": true, + "primary_metadata_object": "primary_metadata_object", + "requires_configuration": true, + "supports_field_creation": true, + "supports_field_type_selection": true, + "supports_target_filters": true, + "target_creator": true, + "use_field_names_as_labels": true + }, + "refreshed_at": "2024-01-01T00:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target/fields \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"database.table\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh=False,\n target=\"database.table\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh: false,\n target: \"database.table\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.TargetRequest{\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: \"database.table\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh=False,\n target=\"database.table\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh: false,\n target: \"database.table\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.TargetRequest{\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: \"database.table\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh=False,\n target=\"database.table\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh: false,\n target: \"database.table\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.TargetRequest{\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: \"database.table\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh=False,\n target=\"database.table\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh: false,\n target: \"database.table\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.TargetRequest{\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: \"database.table\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:id/target/fields", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/connections/:id/target/fields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.connections.get_target_fields(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n refresh=False,\n target=\"database.table\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.connections.getTargetFields(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n refresh: false,\n target: \"database.table\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Connections.GetTargetFields(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.TargetRequest{\n\t\tRefresh: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: \"database.table\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_schemas.GetRecords": { + "id": "endpoint_schemas.GetRecords", + "namespace": [ + "subpackage_schemas" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/connections/" + }, + { + "type": "pathParameter", + "value": "connection_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "schema_id" + }, + { + "type": "literal", + "value": "/records" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "schema_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SchemaRecordsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/contact/records", + "responseStatusCode": 200, + "pathParameters": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "schema_id": "contact" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "data": { + "key": "value" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/contact/records \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:connection_id/:schema_id/records", + "responseStatusCode": 400, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:connection_id/:schema_id/records \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:connection_id/:schema_id/records", + "responseStatusCode": 401, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:connection_id/:schema_id/records \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:connection_id/:schema_id/records", + "responseStatusCode": 403, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:connection_id/:schema_id/records \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:connection_id/:schema_id/records", + "responseStatusCode": 404, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:connection_id/:schema_id/records \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/connections/:connection_id/:schema_id/records", + "responseStatusCode": 500, + "pathParameters": { + "connection_id": ":connection_id", + "schema_id": ":schema_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/connections/:connection_id/:schema_id/records \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.schemas.get_records(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n schema_id=\"contact\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.schemas.getRecords(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"contact\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Schemas.GetRecords(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"contact\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Post": { + "id": "endpoint_models.Post", + "namespace": [ + "subpackage_models" + ], + "description": "For a given connection and enrichment configuration, provides the valid sets of input fields.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/enrichment/" + }, + { + "type": "pathParameter", + "value": "connection_id" + }, + { + "type": "literal", + "value": "/inputfields" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherConfiguration" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:V2GetEnrichmentInputFieldsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields", + "responseStatusCode": 200, + "pathParameters": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": [ + [ + "data" + ] + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 401, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 403, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 404, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/api/enrichment/:connection_id/inputfields", + "responseStatusCode": 500, + "pathParameters": { + "connection_id": ":connection_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/enrichment/:connection_id/inputfields \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Preview": { + "id": "endpoint_models.Preview", + "namespace": [ + "subpackage_models" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/model-preview" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateModelRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/model-preview", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/model-preview \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/api/model-preview", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/model-preview?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.List": { + "id": "endpoint_models.List", + "namespace": [ + "subpackage_models" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Create": { + "id": "endpoint_models.Create", + "namespace": [ + "subpackage_models" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/models" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CreateModelRequest" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/models \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.create({\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelRequest{\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.create({\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelRequest{\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.create({\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelRequest{\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.create({\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelRequest{\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/models?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.create(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.create({\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelRequest{\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Get": { + "id": "endpoint_models.Get", + "namespace": [ + "subpackage_models" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Remove": { + "id": "endpoint_models.Remove", + "namespace": [ + "subpackage_models" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Models.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Update": { + "id": "endpoint_models.Update", + "namespace": [ + "subpackage_models" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "additional_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelModelFieldRequest" + } + } + } + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelRelation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "async": false + }, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Users" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "configuration": { + "table": "public.contacts" + }, + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "phone_number", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "mappings": { + "mappings": "mappings" + } + }, + "fields": [ + { + "description": "Unique identifier", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "label": "ID", + "name": "id", + "remote_type": "string", + "type": "string", + "unique": true, + "user_added": false + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identifier": "id", + "labels": [ + {} + ], + "name": "Contacts", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "relations": [ + { + "from": "id" + } + ], + "tracking_columns": [ + "tracking_columns" + ], + "type": "postgresql", + "version": 1 + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d?async=false\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"name\": \"Users\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "connection_id": "string", + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH \"https://app.polytomic.com/api/models/:id?async=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connection_id\": \"string\",\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.models.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n async_=False,\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier=\"id\",\n name=\"Users\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.models.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n async: false,\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n identifier: \"id\",\n name: \"Users\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Models.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelRequest{\n\t\tAsync: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\tIdentifier: polytomicgo.String(\n\t\t\t\"id\",\n\t\t),\n\t\tName: \"Users\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_models.Sample": { + "id": "endpoint_models.Sample", + "namespace": [ + "subpackage_models" + ], + "description": "Returns sample records from the model. The first ten records that the source provides will be returned after being enriched (if applicable). Synchronous requests must complete within 10s. If either querying or enrichment exceeds 10s, please use the async option.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/models/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/sample" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "async", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSampleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/models/248df4b7-aa70-47b8-a036-33ac447e668d/sample", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "records": [ + { + "records": {} + } + ], + "warnings": [ + "Enrichment failed for 4 records: you have ran out of credits" + ] + }, + "job": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d/sample \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + }, + { + "path": "/api/models/:id/sample", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "async": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/models/:id/sample \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d async=true", + "generated": true + } + ] + } + } + ] + }, + "endpoint_events.List": { + "id": "endpoint_events.List", + "namespace": [ + "subpackage_events" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/events" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "queryParameters": [ + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "starting_after", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "ending_before", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EventsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/events", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "starting_after": "2020-01-01T00:00:00Z", + "ending_before": "2020-01-01T00:00:00Z" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "created_at": "2024-01-01T00:00:00Z", + "event": { + "key": "value" + }, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "sync.running" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=248df4b7-aa70-47b8-a036-33ac447e668d \\\n --data-urlencode starting_after=2020-01-01T00:00:00Z \\\n --data-urlencode ending_before=2020-01-01T00:00:00Z", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.events.api_v_2_get_events(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.events.apiV2GetEvents({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.events.api_v_2_get_events(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.events.apiV2GetEvents({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.events.api_v_2_get_events(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.events.apiV2GetEvents({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": { + "organization_id": "string", + "type": "string" + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://app.polytomic.com/api/events \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -d organization_id=string \\\n -d type=string", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "import datetime\n\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.events.api_v_2_get_events(\n organization_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n ending_before=datetime.datetime.fromisoformat(\n \"2020-01-01 00:00:00+00:00\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.events.apiV2GetEvents({\n organization_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n starting_after: new Date(\"2020-01-01T00:00:00.000Z\"),\n ending_before: new Date(\"2020-01-01T00:00:00.000Z\")\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.List(\n\tcontext.TODO(),\n\t&polytomicgo.EventsListRequest{\n\t\tOrganizationId: polytomicgo.String(\n\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t),\n\t\tStartingAfter: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t\tEndingBefore: polytomicgo.Time(\n\t\t\tpolytomicgo.MustParseDateTime(\n\t\t\t\t\"2020-01-01T00:00:00Z\",\n\t\t\t),\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_events.GetTypes": { + "id": "endpoint_events.GetTypes", + "namespace": [ + "subpackage_events" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/events_types" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:EventTypesEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/events_types", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + "data" + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/events_types \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.events.api_v_2_get_event_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.events.apiV2GetEventTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/events_types", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/events_types \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.events.api_v_2_get_event_types()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.events.apiV2GetEventTypes();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Events.GetTypes(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_jobs.Get": { + "id": "endpoint_jobs.Get", + "namespace": [ + "subpackage_jobs" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/jobs/" + }, + { + "type": "pathParameter", + "value": "type" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:JobResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/jobs/createmodel/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "createmodel" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "error": "error message", + "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "result": { + "key": "value" + }, + "status": "running", + "type": "createmodel" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/createmodel/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/jobs/:type/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/jobs/:type/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.jobs.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n type=\"createmodel\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.jobs.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"createmodel\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Jobs.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"createmodel\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_identity.Get": { + "id": "endpoint_identity.Get", + "namespace": [ + "subpackage_identity" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/me" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetIdentityResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/me", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "is_organization": false, + "is_partner": false, + "is_system": false, + "is_user": true, + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_name": "My Organization", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Identity.Get(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Identity.Get(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/me", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/me \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Identity.Get(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.List": { + "id": "endpoint_organization.List", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationsEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Create": { + "id": "endpoint_organization.Create", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "client_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "client_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Organization" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Organization\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.create({\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.create({\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.create({\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.create(\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.create({\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Get": { + "id": "endpoint_organization.Get", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Remove": { + "id": "endpoint_organization.Remove", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Organization.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_organization.Update": { + "id": "endpoint_organization.Update", + "namespace": [ + "subpackage_organization" + ], + "description": "> 🚧 Requires partner key\n>\n> Organization endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "client_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "client_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:OrganizationEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "My Organization" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "id", + "issuer": "https://example.com", + "name": "My Organization", + "sso_domain": "example.com", + "sso_org_id": "123456" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"My Organization\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.organization.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n client_id=\"client_id\",\n client_secret=\"client_secret\",\n issuer=\"https://example.com\",\n name=\"My Organization\",\n sso_domain=\"example.com\",\n sso_org_id=\"123456\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.organization.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n issuer: \"https://example.com\",\n name: \"My Organization\",\n sso_domain: \"example.com\",\n sso_org_id: \"123456\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Organization.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateOrganizationRequestSchema{\n\t\tClientId: polytomicgo.String(\n\t\t\t\"client_id\",\n\t\t),\n\t\tClientSecret: polytomicgo.String(\n\t\t\t\"client_secret\",\n\t\t),\n\t\tIssuer: polytomicgo.String(\n\t\t\t\"https://example.com\",\n\t\t),\n\t\tName: \"My Organization\",\n\t\tSsoDomain: polytomicgo.String(\n\t\t\t\"example.com\",\n\t\t),\n\t\tSsoOrgId: polytomicgo.String(\n\t\t\t\"123456\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.List": { + "id": "endpoint_users.List", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListUsersEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.list(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.list(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 404, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.list(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Create": { + "id": "endpoint_users.Create", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "email": "mail@example.com" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"mail@example.com\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 422, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users", + "responseStatusCode": 500, + "pathParameters": { + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/organizations/:org_id/users \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.create(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Create(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.CreateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Get": { + "id": "endpoint_users.Get", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Remove": { + "id": "endpoint_users.Remove", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.Update": { + "id": "endpoint_users.Update", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:UserEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "email": "mail@example.com" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "email": "mail@example.com", + "id": "id", + "organization_id": "organization_id", + "role": "admin" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"mail@example.com\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id", + "org_id": ":org_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "email": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/organizations/:org_id/users/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n email=\"mail@example.com\",\n role=\"admin\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n email: \"mail@example.com\",\n role: \"admin\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateUserRequestSchema{\n\t\tEmail: \"mail@example.com\",\n\t\tRole: polytomicgo.String(\n\t\t\t\"admin\",\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_users.CreateApiKey": { + "id": "endpoint_users.CreateApiKey", + "namespace": [ + "subpackage_users" + ], + "description": "> 🚧 Requires partner key\n>\n> User endpoints are only accessible using [partner keys](https://apidocs.polytomic.com/getting-started/obtaining-api-keys#partner-keys)", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/organizations/" + }, + { + "type": "pathParameter", + "value": "org_id" + }, + { + "type": "literal", + "value": "/users/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/keys" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "org_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "queryParameters": [ + { + "key": "force", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:APIKeyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d/keys", + "responseStatusCode": 200, + "pathParameters": { + "org_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": { + "force": true + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "value": "value" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d/keys?force=true\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 401, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 404, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/organizations/:org_id/users/:id/keys", + "responseStatusCode": 500, + "pathParameters": { + "org_id": ":org_id", + "id": ":id" + }, + "queryParameters": { + "force": true + }, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST \"https://app.polytomic.com/api/organizations/:org_id/users/:id/keys?force=true\" \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.users.create_api_key(\n org_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n force=True,\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.users.createApiKey(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n force: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Users.CreateApiKey(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UsersCreateApiKeyRequest{\n\t\tForce: polytomicgo.Bool(\n\t\t\ttrue,\n\t\t),\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.List": { + "id": "endpoint_permissions/policies.List", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListPoliciesResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Create": { + "id": "endpoint_permissions/policies.Create", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/policies \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.create(\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.create({\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Create(\n\tcontext.TODO(),\n\t&permissions.CreatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Get": { + "id": "endpoint_permissions/policies.Get", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Remove": { + "id": "endpoint_permissions/policies.Remove", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Policies.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/policies.Update": { + "id": "endpoint_permissions/policies.Update", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/policies" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/permissions/policies/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PolicyResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Policy", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "policy_actions": [ + { + "action": "read", + "role_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + ], + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/policies/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/policies/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import PolicyAction\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.policies.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n policy_actions=[\n PolicyAction(\n action=\"read\",\n role_ids=[\"248df4b7-aa70-47b8-a036-33ac447e668d\"],\n )\n ],\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.policies.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\",\n policy_actions: [{\n action: \"read\",\n role_ids: [\"248df4b7-aa70-47b8-a036-33ac447e668d\"]\n }]\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Policies.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdatePolicyRequest{\n\t\tName: \"Custom\",\n\t\tPolicyActions: []*polytomicgo.PolicyAction{\n\t\t\t&polytomicgo.PolicyAction{\n\t\t\t\tAction: \"read\",\n\t\t\t\tRoleIds: []string{\n\t\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.List": { + "id": "endpoint_permissions/roles.List", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleListResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Create": { + "id": "endpoint_permissions/roles.Create", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/permissions/roles \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.create(\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.create({\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Create(\n\tcontext.TODO(),\n\t&permissions.CreateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Get": { + "id": "endpoint_permissions/roles.Get", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Remove": { + "id": "endpoint_permissions/roles.Remove", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Permissions.Roles.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_permissions/roles.Update": { + "id": "endpoint_permissions/roles.Update", + "namespace": [ + "subpackage_permissions", + "subpackage_permissions/roles" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/permissions/roles/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RoleResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "name": "Custom" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "name": "Custom", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "system": false + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Custom\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/permissions/roles/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "name": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/permissions/roles/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.permissions.roles.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n name=\"Custom\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.permissions.roles.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n name: \"Custom\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpermissions \"github.com/polytomic/polytomic-go/permissions\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Permissions.Roles.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&permissions.UpdateRoleRequest{\n\t\tName: \"Custom\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.List": { + "id": "endpoint_modelSync.List", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "search_values": { + "name": "value" + } + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Create": { + "id": "endpoint_modelSync.Create", + "namespace": [ + "subpackage_modelSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + }, + "description": "Values to set as sync target fields." + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + }, + "description": "Conditional value replacement for field mappings." + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:Schedule" + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "id", + "id": "type_:Target" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "mode": "create", + "name": "Users Sync", + "schedule": {}, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"create\",\n \"name\": \"Users Sync\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"object\": \"Users\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.create({\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.create({\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.create({\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.create({\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.create({\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.create(\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.create({\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetScheduleOptions": { + "id": "endpoint_modelSync.GetScheduleOptions", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/schedules" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ScheduleOptionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/schedules", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "schedule_options": [ + { + "description": "Runs when manually triggered", + "label": "Manual" + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_schedule_options()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.getScheduleOptions();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetScheduleOptions(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/schedules", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_schedule_options()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.getScheduleOptions();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetScheduleOptions(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/schedules", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/schedules \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_schedule_options()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.getScheduleOptions();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetScheduleOptions(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Get": { + "id": "endpoint_modelSync.Get", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Remove": { + "id": "endpoint_modelSync.Remove", + "namespace": [ + "subpackage_modelSync" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.remove(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.remove(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Update": { + "id": "endpoint_modelSync.Update", + "namespace": [ + "subpackage_modelSync" + ], + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + }, + "description": "Values to set as sync target fields." + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + }, + "description": "Conditional value replacement for field mappings." + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:Schedule" + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "id", + "id": "type_:Target" + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "mode": "create", + "name": "Users Sync", + "schedule": {}, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "filter_logic": "filter_logic", + "filters": [ + { + "function": "Equality", + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1", + "label": "A" + } + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "identity": { + "function": "Equality", + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name", + "new_field": true, + "remote_field_type_id": "string" + }, + "mode": "create", + "name": "Users Sync", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "override_fields": [ + { + "source": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "target": "name" + } + ], + "overrides": [ + { + "field": { + "field": "id", + "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "field_id": "field1" + } + ], + "policies": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "schedule": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "day_of_month": "1", + "day_of_week": "monday", + "frequency": "manual", + "hour": "12", + "job_id": 1, + "minute": "30", + "month": "1", + "run_after": { + "bulk_sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ], + "sync_ids": [ + "248df4b7-aa70-47b8-a036-33ac447e668d" + ] + } + }, + "sync_all_records": false, + "target": { + "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "object": "Users", + "configuration": { + "key": "value" + }, + "filter_logic": "filter_logic", + "new_name": "new_name", + "search_values": { + "name": "value" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"create\",\n \"name\": \"Users Sync\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n \"object\": \"Users\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "mode": "string", + "name": "string", + "schedule": {}, + "target": { + "connection_id": "string", + "object": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/syncs/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"string\",\n \"name\": \"string\",\n \"schedule\": {},\n \"target\": {\n \"connection_id\": \"string\",\n \"object\": \"string\"\n }\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import Identity, ModelSyncField, Schedule, Source, Target\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n fields=[\n ModelSyncField(\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n )\n ],\n filter_logic=\"A and B or C\",\n identity=Identity(\n function=\"Equality\",\n source=Source(\n field=\"id\",\n model_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n ),\n target=\"name\",\n ),\n mode=\"create\",\n name=\"Users Sync\",\n schedule=Schedule(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency=\"daily\",\n ),\n sync_all_records=False,\n target=Target(\n connection_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object=\"Users\",\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n fields: [{\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n }],\n filter_logic: \"A and B or C\",\n identity: {\n function: \"Equality\",\n source: {\n field: \"id\",\n model_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\"\n },\n target: \"name\"\n },\n mode: \"create\",\n name: \"Users Sync\",\n schedule: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n frequency: \"daily\"\n },\n sync_all_records: false,\n target: {\n connection_id: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n object: \"Users\"\n }\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateModelSyncRequest{\n\t\tFields: []*polytomicgo.ModelSyncField{\n\t\t\t&polytomicgo.ModelSyncField{\n\t\t\t\tSource: &polytomicgo.Source{\n\t\t\t\t\tField: \"id\",\n\t\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t\t},\n\t\t\t\tTarget: \"name\",\n\t\t\t},\n\t\t},\n\t\tFilterLogic: polytomicgo.String(\n\t\t\t\"A and B or C\",\n\t\t),\n\t\tIdentity: &polytomicgo.Identity{\n\t\t\tFunction: \"Equality\",\n\t\t\tSource: &polytomicgo.Source{\n\t\t\t\tField: \"id\",\n\t\t\t\tModelId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t},\n\t\t\tTarget: \"name\",\n\t\t},\n\t\tMode: \"create\",\n\t\tName: \"Users Sync\",\n\t\tSchedule: &polytomicgo.Schedule{\n\t\t\tConnectionId: polytomicgo.String(\n\t\t\t\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\t),\n\t\t\tFrequency: polytomicgo.String(\n\t\t\t\t\"daily\",\n\t\t\t),\n\t\t},\n\t\tSyncAllRecords: polytomicgo.Bool(\n\t\t\tfalse,\n\t\t),\n\t\tTarget: &polytomicgo.Target{\n\t\t\tConnectionId: \"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\t\tObject: \"Users\",\n\t\t},\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Activate": { + "id": "endpoint_modelSync.Activate", + "namespace": [ + "subpackage_modelSync" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/activate" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncInput" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ActivateSyncEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "active": true, + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/activate", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "active": true + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/activate \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"active\": true\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic import ActivateSyncInput\nfrom polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.activate(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n request=ActivateSyncInput(\n active=True,\n ),\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.activate(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n active: true\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Activate(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.ActivateSyncInput{\n\t\tActive: true,\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.Start": { + "id": "endpoint_modelSync.Start", + "namespace": [ + "subpackage_modelSync" + ], + "description": "> 🚧 Force full resync\n>\n> Use caution when setting the `resync` parameter to `true`. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "identities", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "resync", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:StartModelSyncResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Forbidden", + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "status": "created" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 403, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/executions", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/syncs/:id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.start(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.start(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Start(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.StartModelSyncRequest{},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync.GetStatus": { + "id": "endpoint_modelSync.GetStatus", + "namespace": [ + "subpackage_modelSync" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:SyncStatusEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "current_execution": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + }, + "last_execution": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + }, + "next_execution_time": "2024-01-01T00:00:00Z" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:id/status", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:id/status \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.get_status(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.getStatus(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.GetStatus(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.List": { + "id": "endpoint_modelSync/executions.List", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ListExecutionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.list(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.list(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.list(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.executions.list(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.List(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.Get": { + "id": "endpoint_modelSync/executions.Get", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GetExecutionResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "completed_at": "2024-01-01T00:00:00Z", + "counts": { + "error": 5, + "insert": 80, + "total": 100, + "update": 15 + }, + "created_at": "2024-01-01T00:00:00Z", + "errors": [ + "something went wrong" + ], + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "started_at": "2024-01-01T00:00:00Z", + "status": "created", + "type": "scheduled" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.model_sync.executions.get(\n sync_id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.modelSync.executions.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\", \"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.GetLogUrls": { + "id": "endpoint_modelSync/executions.GetLogUrls", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "type" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ExecutionLogsResponseEnvelope" + } + } + }, + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records", + "responseStatusCode": 200, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "records" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "expires": "2024-01-01T00:00:00Z", + "urls": [ + "urls" + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 400, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.ModelSync.Executions.GetLogUrls(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_modelSync/executions.GetLogs": { + "id": "endpoint_modelSync/executions.GetLogs", + "namespace": [ + "subpackage_modelSync", + "subpackage_modelSync/executions" + ], + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/syncs/" + }, + { + "type": "pathParameter", + "value": "sync_id" + }, + { + "type": "literal", + "value": "/executions/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "type" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "filename" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "sync_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Bad Request", + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records/path/to/file.json", + "responseStatusCode": 204, + "pathParameters": { + "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "type": "records", + "filename": "path/to/file.json" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/records/path/to/file.json \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 400, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 401, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 404, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/syncs/:sync_id/executions/:id/:type/:filename", + "responseStatusCode": 500, + "pathParameters": { + "sync_id": ":sync_id", + "id": ":id", + "type": ":type", + "filename": ":filename" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/syncs/:sync_id/executions/:id/:type/:filename \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.ModelSync.Executions.GetLogs(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t\"records\",\n\t\"path/to/file.json\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.List": { + "id": "endpoint_webhooks.List", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookListEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.list()\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.list();\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.List(\n\tcontext.TODO(),\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Create": { + "id": "endpoint_webhooks.Create", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/api/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 6, + "maxLength": 6 + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "endpoint": "https://example.com/webhook", + "secret": "secret" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"https://example.com/webhook\",\n \"secret\": \"secret\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks", + "responseStatusCode": 500, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://app.polytomic.com/api/webhooks \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.create(\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.create({\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Create(\n\tcontext.TODO(),\n\t&polytomicgo.CreateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Get": { + "id": "endpoint_webhooks.Get", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.get(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.get(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Get(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Remove": { + "id": "endpoint_webhooks.Remove", + "namespace": [ + "subpackage_webhooks" + ], + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Not Found", + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 204, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \"", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.delete(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.delete(\"248df4b7-aa70-47b8-a036-33ac447e668d\");\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nerr := client.Webhooks.Remove(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n)\n", + "generated": true + } + ] + } + } + ] + }, + "endpoint_webhooks.Update": { + "id": "endpoint_webhooks.Update", + "namespace": [ + "subpackage_webhooks" + ], + "description": "Webooks can be set up using the webhook API endpoints. Currently, only one\nwebhook may be created per organization. The webhook will be called for events\nin that organization.\n\nConsult the [Events documentation](https://apidocs.polytomic.com/getting-started/events) for more information.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/api/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://app.polytomic.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "endpoint", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "primitive", + "value": { + "type": "string", + "minLength": 6, + "maxLength": 6 + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookEnvelope" + } + } + }, + "errors": [ + { + "description": "Unauthorized", + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RestErrResponse" + } + }, + "examples": [] + }, + { + "description": "Unprocessable Entity", + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + }, + { + "description": "Internal Server Error", + "statusCode": 500, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ApiError" + } + }, + "examples": [] + } + ], + "examples": [ + { + "path": "/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d", + "responseStatusCode": 200, + "pathParameters": { + "id": "248df4b7-aa70-47b8-a036-33ac447e668d" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "endpoint": "https://example.com/webhook", + "secret": "secret" + } + }, + "responseBody": { + "type": "json", + "value": { + "data": { + "created_at": "2024-01-01T00:00:00Z", + "endpoint": "https://example.com/webhook", + "id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d", + "secret": "secret" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/248df4b7-aa70-47b8-a036-33ac447e668d \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"https://example.com/webhook\",\n \"secret\": \"secret\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 401, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "code": 0, + "context": { + "string": {} + }, + "error": "string", + "status": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + }, + { + "path": "/api/webhooks/:id", + "responseStatusCode": 500, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Polytomic-Version": "2023-04-25" + }, + "requestBody": { + "type": "json", + "value": { + "endpoint": "string", + "secret": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "message": "string", + "metadata": {}, + "status": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://app.polytomic.com/api/webhooks/:id \\\n -H \"X-Polytomic-Version: 2023-04-25\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"endpoint\": \"string\",\n \"secret\": \"string\"\n}'", + "generated": true + } + ], + "python": [ + { + "language": "python", + "code": "from polytomic.client import Polytomic\n\nclient = Polytomic(\n x_polytomic_version=\"YOUR_X_POLYTOMIC_VERSION\",\n token=\"YOUR_TOKEN\",\n)\nclient.webhooks.update(\n id=\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n endpoint=\"https://example.com/webhook\",\n secret=\"secret\",\n)\n", + "generated": true + } + ], + "typescript": [ + { + "name": "TypeScript SDK", + "language": "typescript", + "code": "import { PolytomicClient } from \"polytomic\";\n\nconst polytomic = new PolytomicClient({ token: \"YOUR_TOKEN\", xPolytomicVersion: \"YOUR_X_POLYTOMIC_VERSION\" });\nawait polytomic.webhooks.update(\"248df4b7-aa70-47b8-a036-33ac447e668d\", {\n endpoint: \"https://example.com/webhook\",\n secret: \"secret\"\n});\n", + "generated": true + } + ], + "go": [ + { + "language": "go", + "code": "import (\n\tcontext \"context\"\n\toption \"github.com/polytomic/polytomic-go/option\"\n\tpolytomicgo \"github.com/polytomic/polytomic-go\"\n\tpolytomicgoclient \"github.com/polytomic/polytomic-go/client\"\n)\n\nclient := polytomicgoclient.NewClient(\n\toption.WithToken(\n\t\t\"\",\n\t),\n)\nresponse, err := client.Webhooks.Update(\n\tcontext.TODO(),\n\t\"248df4b7-aa70-47b8-a036-33ac447e668d\",\n\t&polytomicgo.UpdateWebhooksSchema{\n\t\tEndpoint: \"https://example.com/webhook\",\n\t\tSecret: \"secret\",\n\t},\n)\n", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:ApiError": { + "name": "ApiError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BulkDiscover": { + "name": "BulkDiscover", + "shape": { + "type": "enum", + "values": [ + { + "value": "all" + }, + { + "value": "onlyIncremental" + }, + { + "value": "onlyNonIncremental" + }, + { + "value": "none" + } + ] + } + }, + "type_:BulkExecutionStatus": { + "name": "BulkExecutionStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "scheduled" + }, + { + "value": "running" + }, + { + "value": "exporting" + }, + { + "value": "canceling" + }, + { + "value": "canceled" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "processing" + }, + { + "value": "errors" + } + ] + } + }, + "type_:BulkItemizedSchedule": { + "name": "BulkItemizedSchedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "item", + "valueShape": { + "type": "id", + "id": "type_:BulkSelectiveMode" + } + }, + { + "key": "schedule", + "valueShape": { + "type": "id", + "id": "type_:BulkSchedule" + } + } + ] + } + }, + "type_:BulkMultiScheduleConfiguration": { + "name": "BulkMultiScheduleConfiguration", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schedules", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkItemizedSchedule" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:BulkSchedule": { + "name": "BulkSchedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "day_of_month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_week", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + }, + { + "key": "hour", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "minute", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "multi", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkMultiScheduleConfiguration" + } + } + } + ] + } + }, + "type_:BulkSchemaExecutionStatus": { + "name": "BulkSchemaExecutionStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "scheduled" + }, + { + "value": "running" + }, + { + "value": "exporting" + }, + { + "value": "canceled" + }, + { + "value": "completed" + }, + { + "value": "failed" + } + ] + } + }, + "type_:BulkSelectiveMode": { + "name": "BulkSelectiveMode", + "shape": { + "type": "enum", + "values": [ + { + "value": "none" + }, + { + "value": "incrementalFields" + }, + { + "value": "nonincrementalFields" + } + ] + } + }, + "type_:FilterFieldReferenceType": { + "name": "FilterFieldReferenceType", + "shape": { + "type": "enum", + "values": [ + { + "value": "Model" + }, + { + "value": "Target" + } + ] + } + }, + "type_:FilterFunction": { + "name": "FilterFunction", + "shape": { + "type": "enum", + "values": [ + { + "value": "Equality" + }, + { + "value": "Inequality" + }, + { + "value": "IsNull" + }, + { + "value": "IsNotNull" + }, + { + "value": "True" + }, + { + "value": "False" + }, + { + "value": "OnOrAfter" + }, + { + "value": "OnOrBefore" + }, + { + "value": "GreaterThan" + }, + { + "value": "GreaterThanEqual" + }, + { + "value": "LessThan" + }, + { + "value": "LessThanEqual" + }, + { + "value": "StringContains" + }, + { + "value": "StringEndsWith" + }, + { + "value": "StringDoesNotContain" + }, + { + "value": "StringDoesNotEndWith" + }, + { + "value": "StringOneOf" + }, + { + "value": "StringNotOneOf" + }, + { + "value": "Between" + }, + { + "value": "ArrayContains" + }, + { + "value": "ArrayDoesNotContain" + }, + { + "value": "InTheLast" + }, + { + "value": "StringLike" + }, + { + "value": "StringNotLike" + }, + { + "value": "StringMatchesTrimmed" + } + ] + } + }, + "type_:JsonschemaForm": { + "name": "JsonschemaForm", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:LabelLabel": { + "name": "LabelLabel", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:ModelModelFieldRequest": { + "name": "ModelModelFieldRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "example", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ModelRelation": { + "name": "ModelRelation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "to", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelRelationTo" + } + } + } + ] + } + }, + "type_:ModelRelationTo": { + "name": "ModelRelationTo", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:RestErrResponse": { + "name": "RestErrResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Application-specific error code." + }, + { + "key": "context", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Application context." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Error message." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Status text." + } + ] + } + }, + "type_:ScheduleFrequency": { + "name": "ScheduleFrequency", + "shape": { + "type": "enum", + "values": [ + { + "value": "manual" + }, + { + "value": "continuous" + }, + { + "value": "hourly" + }, + { + "value": "daily" + }, + { + "value": "weekly" + }, + { + "value": "custom" + }, + { + "value": "builder" + }, + { + "value": "runafter" + }, + { + "value": "multi" + }, + { + "value": "dbtcloud" + } + ] + } + }, + "type_:ScheduleScheduleOption": { + "name": "ScheduleScheduleOption", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JsonschemaForm" + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:SchemaAssociation": { + "name": "SchemaAssociation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "reference_to", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "referenced_field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:SchemaIdentityFunction": { + "name": "SchemaIdentityFunction", + "shape": { + "type": "enum", + "values": [ + { + "value": "Equality" + }, + { + "value": "ISubstring" + }, + { + "value": "OneOf" + } + ] + } + }, + "type_:SyncDestinationProperties": { + "name": "SyncDestinationProperties", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "does_not_report_operation_counts", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "new_target_label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "optional_target_mappings", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "primary_metadata_object", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_creation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_type_selection", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target_creator", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "use_field_names_as_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ExecutionStatus": { + "name": "ExecutionStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "created" + }, + { + "value": "scheduled" + }, + { + "value": "queued" + }, + { + "value": "waiting" + }, + { + "value": "running" + }, + { + "value": "processing" + }, + { + "value": "canceling" + }, + { + "value": "canceled" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "interrupted" + } + ] + } + }, + "type_:APIKeyResponse": { + "name": "APIKeyResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:APIKeyResponseEnvelope": { + "name": "APIKeyResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:APIKeyResponse" + } + } + } + ] + } + }, + "type_:ActivateSyncEnvelope": { + "name": "ActivateSyncEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ActivateSyncOutput" + } + } + } + ] + } + }, + "type_:ActivateSyncInput": { + "name": "ActivateSyncInput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + ] + } + }, + "type_:ActivateSyncOutput": { + "name": "ActivateSyncOutput", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncDest": { + "name": "BulkSyncDest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "modes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SupportedMode" + } + } + } + } + ] + } + }, + "type_:BulkSyncDestEnvelope": { + "name": "BulkSyncDestEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncDest" + } + } + } + ] + } + }, + "type_:BulkSyncListEnvelope": { + "name": "BulkSyncListEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSyncResponse" + } + } + } + } + ] + } + }, + "type_:BulkSyncResponse": { + "name": "BulkSyncResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "destination_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "destination_connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "discover", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchedule" + } + } + }, + { + "key": "source_configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "source_connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncResponseEnvelope": { + "name": "BulkSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncResponse" + } + } + } + ] + } + }, + "type_:ConfigurationValue": { + "name": "ConfigurationValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ConnectionListResponseEnvelope": { + "name": "ConnectionListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionResponseSchema" + } + } + } + } + ] + } + }, + "type_:ConnectionMeta": { + "name": "ConnectionMeta", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "has_items", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ConnectionMetaResponse": { + "name": "ConnectionMetaResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "id", + "id": "type_:ConfigurationValue" + } + } + } + }, + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionMeta" + } + } + } + } + }, + { + "key": "requires_one_of", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ConnectionParameterValue": { + "name": "ConnectionParameterValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:ConnectionParameterValuesResp": { + "name": "ConnectionParameterValuesResp", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "allows_creation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "values", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionParameterValue" + } + } + } + } + ] + } + }, + "type_:ConnectionParameterValuesResponseEnvelope": { + "name": "ConnectionParameterValuesResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionParameterValuesResp" + } + } + } + } + } + ] + } + }, + "type_:ConnectionResponseEnvelope": { + "name": "ConnectionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionResponseSchema" + } + } + } + ] + } + }, + "type_:ConnectionResponseSchema": { + "name": "ConnectionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "api_calls_last_24_hours", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "API calls made to service in the last 24h (supported integrations only)." + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status_error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionTypeSchema" + } + } + } + ] + } + }, + "type_:ConnectionType": { + "name": "ConnectionType", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "envConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "use_oauth", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ConnectionTypeResponseEnvelope": { + "name": "ConnectionTypeResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ConnectionType" + } + } + } + } + ] + } + }, + "type_:ConnectionTypeSchema": { + "name": "ConnectionTypeSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "operations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:CreateConnectionResponseEnvelope": { + "name": "CreateConnectionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CreateConnectionResponseSchema" + } + } + } + ] + } + }, + "type_:CreateConnectionResponseSchema": { + "name": "CreateConnectionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "auth_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Code to enter in order to complete connection authentication." + }, + { + "key": "auth_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL to visit to complete connection authentication." + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status_error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionTypeSchema" + } + } + } + ] + } + }, + "type_:CreateModelRequest": { + "name": "CreateModelRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "additional_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelModelFieldRequest" + } + } + } + }, + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelRelation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:V2EnricherConfiguration": { + "name": "V2EnricherConfiguration", + "description": "Similar to a model configuration, this configures the enricher. For example, if you wanted to use Apollo to enrich people, you would send `{\"object\": \"people\"}` as the configuration. Each enricher configuration can be found in the connection configuration docs.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:V2EnricherMapping": { + "name": "V2EnricherMapping", + "description": "A map of parent model Source Name to child model Source Name. For example, if your model has a field called `work_email` and the enricher accepts a field called `email`, you'd send a map of `{\"work_email\":\"email\"}`. The set of required input mappings varies based on the configuration of the enrichment. You can use the `enrichment/{connection_id}/inputfields` API to discover available input field combinations for a given configuration.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "type_:Enrichment": { + "name": "Enrichment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherConfiguration" + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "enricher_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Must be provided to update an existing enrichment" + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + }, + "description": "If not provided, all fields will be enabled." + }, + { + "key": "mappings", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:V2EnricherMapping" + } + } + } + ] + } + }, + "type_:Event": { + "name": "Event", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "event", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:EventTypesEnvelope": { + "name": "EventTypesEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:EventsEnvelope": { + "name": "EventsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Event" + } + } + } + } + ] + } + }, + "type_:ExecutionCounts": { + "name": "ExecutionCounts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "insert", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "update", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:ExecutionLogResponse": { + "name": "ExecutionLogResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "expires", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "urls", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ExecutionLogsResponseEnvelope": { + "name": "ExecutionLogsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionLogResponse" + } + } + } + ] + } + }, + "type_:Filter": { + "name": "Filter", + "description": "Either `field` or `field_id` must be provided. If `field` is provided, `field_id` is ignored.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Source" + } + } + }, + { + "key": "field_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Model or Target field name to filter on." + }, + { + "key": "field_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilterFieldReferenceType" + } + } + }, + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:FilterFunction" + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:GetConnectionMetaEnvelope": { + "name": "GetConnectionMetaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectionMetaResponse" + } + } + } + ] + } + }, + "type_:V2GetEnrichmentInputFieldsResponseEnvelope": { + "name": "V2GetEnrichmentInputFieldsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "type_:GetExecutionResponseEnvelope": { + "name": "GetExecutionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + } + ] + } + }, + "type_:GetExecutionResponseSchema": { + "name": "GetExecutionResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "counts", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionCounts" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "errors", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "started_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:GetIdentityResponseEnvelope": { + "name": "GetIdentityResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetIdentityResponseSchema" + } + } + } + ] + } + }, + "type_:GetIdentityResponseSchema": { + "name": "GetIdentityResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "is_organization", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_partner", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_user", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Identity": { + "name": "Identity", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "function", + "valueShape": { + "type": "id", + "id": "type_:SchemaIdentityFunction" + } + }, + { + "key": "new_field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "remote_field_type_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:IdentityFunction": { + "name": "IdentityFunction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:JobResponse": { + "name": "JobResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WorkTaskStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:JobResponseEnvelope": { + "name": "JobResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:ListExecutionResponseEnvelope": { + "name": "ListExecutionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + } + } + ] + } + }, + "type_:ListPoliciesResponseEnvelope": { + "name": "ListPoliciesResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyResponse" + } + } + } + } + ] + } + }, + "type_:ListModelSyncResponseEnvelope": { + "name": "ListModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncResponse" + } + } + } + } + ] + } + }, + "type_:ListUsersEnvelope": { + "name": "ListUsersEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:User" + } + } + } + } + ] + } + }, + "type_:Mode": { + "name": "Mode", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelField": { + "name": "ModelField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "example", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "remote_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "unique", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "user_added", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelFieldResponse": { + "name": "ModelFieldResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + } + } + ] + } + }, + "type_:ModelListResponseEnvelope": { + "name": "ModelListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelResponse" + } + } + } + } + ] + } + }, + "type_:ModelResponse": { + "name": "ModelResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "enricher", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Enrichment" + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identifier", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LabelLabel" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "relations", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Relation" + } + } + } + }, + { + "key": "tracking_columns", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:ModelResponseEnvelope": { + "name": "ModelResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelResponse" + } + } + }, + { + "key": "job", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:ModelSample": { + "name": "ModelSample", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "records", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:V2SampleRecord" + } + } + } + }, + { + "key": "warnings", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:ModelSampleResponseEnvelope": { + "name": "ModelSampleResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelSample" + } + } + }, + { + "key": "job", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:JobResponse" + } + } + } + ] + } + }, + "type_:Organization": { + "name": "Organization", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuer", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_domain", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "sso_org_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:OrganizationEnvelope": { + "name": "OrganizationEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Organization" + } + } + } + ] + } + }, + "type_:OrganizationsEnvelope": { + "name": "OrganizationsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Organization" + } + } + } + } + ] + } + }, + "type_:Override": { + "name": "Override", + "description": "Either `field` or `field_id` must be provided. If `field_id` is provided, `field` is ignored.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Source" + } + } + }, + { + "key": "field_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Field ID of the model field to override." + }, + { + "key": "function", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FilterFunction" + } + } + }, + { + "key": "override", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + } + ] + } + }, + "type_:PolicyAction": { + "name": "PolicyAction", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "action", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "role_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:PolicyResponse": { + "name": "PolicyResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "policy_actions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PolicyAction" + } + } + } + }, + { + "key": "system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:PolicyResponseEnvelope": { + "name": "PolicyResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PolicyResponse" + } + } + } + ] + } + }, + "type_:Relation": { + "name": "Relation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "to", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RelationTo" + } + } + } + ] + } + }, + "type_:RelationTo": { + "name": "RelationTo", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:RoleListResponseEnvelope": { + "name": "RoleListResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:RoleResponse" + } + } + } + } + ] + } + }, + "type_:RoleResponse": { + "name": "RoleResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "system", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:RoleResponseEnvelope": { + "name": "RoleResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RoleResponse" + } + } + } + ] + } + }, + "type_:RunAfter": { + "name": "RunAfter", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bulk_sync_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "sync_ids", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + ] + } + }, + "type_:V2SampleRecord": { + "name": "V2SampleRecord", + "description": "A map of `fieldSource` -> `fieldName: fieldValue`. Because there may be field name conflicts between the base model and enrichments, the base model fields are placed in a map under the model ID. Fields from enrichments are placed under the enricher ID.", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + }, + "type_:Schedule": { + "name": "Schedule", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "connection_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "day_of_week", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "frequency", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleFrequency" + } + } + }, + { + "key": "hour", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "job_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "minute", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "month", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "run_after", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RunAfter" + } + } + } + ] + } + }, + "type_:ScheduleOptionResponse": { + "name": "ScheduleOptionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "schedule_options", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ScheduleScheduleOption" + } + } + } + } + ] + } + }, + "type_:ScheduleOptionResponseEnvelope": { + "name": "ScheduleOptionResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ScheduleOptionResponse" + } + } + } + ] + } + }, + "type_:Source": { + "name": "Source", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "model_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:StartModelSyncResponseEnvelope": { + "name": "StartModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StartModelSyncResponseSchema" + } + } + } + ] + } + }, + "type_:StartModelSyncResponseSchema": { + "name": "StartModelSyncResponseSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExecutionStatus" + } + } + } + ] + } + }, + "type_:SupportedMode": { + "name": "SupportedMode", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "requires_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_field_sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "supports_target_filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ModelSyncField": { + "name": "ModelSyncField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "new", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "override_value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "source", + "valueShape": { + "type": "id", + "id": "type_:Source" + } + }, + { + "key": "sync_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:ModelSyncResponse": { + "name": "ModelSyncResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "active", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filters", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Filter" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Identity" + } + } + }, + { + "key": "mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "override_fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ModelSyncField" + } + } + } + }, + { + "key": "overrides", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Override" + } + } + } + }, + { + "key": "policies", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + { + "key": "schedule", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Schedule" + } + } + }, + { + "key": "sync_all_records", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "target", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Target" + } + } + } + ] + } + }, + "type_:ModelSyncResponseEnvelope": { + "name": "ModelSyncResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ModelSyncResponse" + } + } + } + ] + } + }, + "type_:SyncStatusEnvelope": { + "name": "SyncStatusEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SyncStatusResponse" + } + } + } + ] + } + }, + "type_:SyncStatusResponse": { + "name": "SyncStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "current_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + }, + { + "key": "last_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:GetExecutionResponseSchema" + } + } + }, + { + "key": "next_execution_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:Target": { + "name": "Target", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + { + "key": "connection_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "filter_logic", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "new_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "object", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "search_values", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + ] + } + }, + "type_:TargetField": { + "name": "TargetField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "association", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "createable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "filterable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "identity_functions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:IdentityFunction" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "required", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "source_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "supports_identity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "updateable", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:TargetResponse": { + "name": "TargetResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TargetField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "modes", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Mode" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "properties", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SyncDestinationProperties" + } + } + }, + { + "key": "refreshed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:TargetResponseEnvelope": { + "name": "TargetResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TargetResponse" + } + } + } + ] + } + }, + "type_:User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "role", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:UserEnvelope": { + "name": "UserEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:User" + } + } + } + ] + } + }, + "type_:Webhook": { + "name": "Webhook", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "endpoint", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "organization_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:WebhookEnvelope": { + "name": "WebhookEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Webhook" + } + } + } + ] + } + }, + "type_:WebhookListEnvelope": { + "name": "WebhookListEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Webhook" + } + } + } + } + ] + } + }, + "type_:BulkField": { + "name": "BulkField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "obfuscated", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:BulkSchema": { + "name": "BulkSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "output_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "partition_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSchemaEnvelope": { + "name": "BulkSchemaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + ] + } + }, + "type_:BulkSyncExecution": { + "name": "BulkSyncExecution", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "is_resync", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "is_test", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSyncSchemaExecution" + } + } + } + }, + { + "key": "started_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkExecutionStatus" + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncExecutionEnvelope": { + "name": "BulkSyncExecutionEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + } + ] + } + }, + "type_:BulkSyncSchemaExecution": { + "name": "BulkSyncSchemaExecution", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "completed_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "error_count", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "record_count", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "schema", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "started_at", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSchemaExecutionStatus" + } + } + }, + { + "key": "status_message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:BulkSyncSource": { + "name": "BulkSyncSource", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "configuration", + "valueShape": { + "type": "optional", + "shape": { + "type": "unknown" + } + } + }, + { + "key": "schemas", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Schema" + } + } + } + } + ] + } + }, + "type_:BulkSyncSourceEnvelope": { + "name": "BulkSyncSourceEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncSource" + } + } + } + ] + } + }, + "type_:BulkSyncSourceSchemaEnvelope": { + "name": "BulkSyncSourceSchemaEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Schema" + } + } + } + ] + } + }, + "type_:BulkSyncSourceStatus": { + "name": "BulkSyncSourceStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "cache_status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last_refresh_finished", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "last_refresh_started", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:BulkSyncSourceStatusEnvelope": { + "name": "BulkSyncSourceStatusEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncSourceStatus" + } + } + } + ] + } + }, + "type_:BulkSyncStatusEnvelope": { + "name": "BulkSyncStatusEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncStatusResponse" + } + } + } + ] + } + }, + "type_:BulkSyncStatusResponse": { + "name": "BulkSyncStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "current_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + }, + { + "key": "last_execution", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + }, + { + "key": "next_execution_time", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "type_:ConnectCardResponse": { + "name": "ConnectCardResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "redirect_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:ConnectCardResponseEnvelope": { + "name": "ConnectCardResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ConnectCardResponse" + } + } + } + ] + } + }, + "type_:ListBulkSchema": { + "name": "ListBulkSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSchema" + } + } + } + } + ] + } + }, + "type_:ListBulkSyncExecutionsEnvelope": { + "name": "ListBulkSyncExecutionsEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:BulkSyncExecution" + } + } + } + } + ] + } + }, + "type_:PickValue": { + "name": "PickValue", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "label", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:Schema": { + "name": "Schema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fields", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:SchemaField" + } + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:SchemaField": { + "name": "SchemaField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "association", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SchemaAssociation" + } + } + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "remote_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "values", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PickValue" + } + } + } + } + ] + } + }, + "type_:SchemaRecordsResponseEnvelope": { + "name": "SchemaRecordsResponseEnvelope", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + } + ] + } + }, + "type_:WorkTaskStatus": { + "name": "WorkTaskStatus", + "shape": { + "type": "enum", + "values": [ + { + "value": "running" + }, + { + "value": "done" + }, + { + "value": "failed" + } + ] + } + } + }, + "subpackages": { + "subpackage_bulkSync": { + "id": "subpackage_bulkSync", + "name": "bulkSync" + }, + "subpackage_bulkSync/executions": { + "id": "subpackage_bulkSync/executions", + "name": "executions" + }, + "subpackage_bulkSync/schemas": { + "id": "subpackage_bulkSync/schemas", + "name": "schemas" + }, + "subpackage_connections": { + "id": "subpackage_connections", + "name": "connections" + }, + "subpackage_schemas": { + "id": "subpackage_schemas", + "name": "schemas" + }, + "subpackage_models": { + "id": "subpackage_models", + "name": "models" + }, + "subpackage_events": { + "id": "subpackage_events", + "name": "events" + }, + "subpackage_jobs": { + "id": "subpackage_jobs", + "name": "jobs" + }, + "subpackage_identity": { + "id": "subpackage_identity", + "name": "identity" + }, + "subpackage_organization": { + "id": "subpackage_organization", + "name": "organization" + }, + "subpackage_users": { + "id": "subpackage_users", + "name": "users" + }, + "subpackage_permissions": { + "id": "subpackage_permissions", + "name": "permissions" + }, + "subpackage_permissions/policies": { + "id": "subpackage_permissions/policies", + "name": "policies" + }, + "subpackage_permissions/roles": { + "id": "subpackage_permissions/roles", + "name": "roles" + }, + "subpackage_modelSync": { + "id": "subpackage_modelSync", + "name": "modelSync" + }, + "subpackage_modelSync/executions": { + "id": "subpackage_modelSync/executions", + "name": "executions" + }, + "subpackage_webhooks": { + "id": "subpackage_webhooks", + "name": "webhooks" + } + }, + "auths": { + "default": { + "type": "bearerAuth", + "tokenName": "token" + } + }, + "globalHeaders": [ + { + "key": "X-Polytomic-Version", + "valueShape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "2023-04-25" + } + } + } + ] + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/node.json b/packages/fdr-sdk/src/__test__/output/polytomic/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/node.json rename to packages/fdr-sdk/src/__test__/output/polytomic/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/polytomic/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/polytomic/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/polytomic/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/polytomic/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/pageIds.json b/packages/fdr-sdk/src/__test__/output/polytomic/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/pageIds.json rename to packages/fdr-sdk/src/__test__/output/polytomic/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/sitemap.json b/packages/fdr-sdk/src/__test__/output/polytomic/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/sitemap.json rename to packages/fdr-sdk/src/__test__/output/polytomic/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/polytomic/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/polytomic/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/polytomic/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/polytomic/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/slugs.json b/packages/fdr-sdk/src/__test__/output/polytomic/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/slugs.json rename to packages/fdr-sdk/src/__test__/output/polytomic/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/polytomic/versionNodes.json b/packages/fdr-sdk/src/__test__/output/polytomic/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/polytomic/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/polytomic/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-090e0b31-c453-4f41-8269-845a6e8a461f.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-090e0b31-c453-4f41-8269-845a6e8a461f.json new file mode 100644 index 0000000000..88a18249f9 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-090e0b31-c453-4f41-8269-845a6e8a461f.json @@ -0,0 +1,2553 @@ +[ + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/query/clientToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customer", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/clientToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/customer", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/status", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/payment_method_type", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/processor", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/currency_code", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/from_date", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/to_date", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/order_id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/min_amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/max_amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/customer_id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/merchant_id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/customer_email_address", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/last_4_digits", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/paypal_email", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/klarna_email", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/limit", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/query/cursor", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/requestHeader/X-Idempotency-Key", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethodToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customer", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/requestHeader/X-Idempotency-Key", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/request/object/property/processor", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/3/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/4/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/requestHeader/X-Idempotency-Key", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/final", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/requestHeader/X-Idempotency-Key", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/request/object/property/reason", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/requestHeader/X-Idempotency-Key", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/reason", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/request/object/property/resumeToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/requestHeader/X-Idempotency-Key", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/request/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/3/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/path/paymentMethodToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/query/customer_id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/path/paymentMethodToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/path/paymentMethodToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/path/paymentId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/paymentId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/processor", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/createdAt", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/status", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/statusReason", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/paymentType", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/descriptor", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/path/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/query/connectionId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/connectionId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/limit", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/offset", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/connectionId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/type", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/value", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/0/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/1/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/2/snippet/curl/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder/shape/object/property/retailerCountryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AFN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ALL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ANG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AOA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ARS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AUD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AWG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AZN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BAM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BDT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BGN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BHD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BIF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BOB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BOV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BRL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BSD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BTN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BWP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BYR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BYN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CDF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CHE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CHF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CHW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CLF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CLP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CNY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/COP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/COU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CRC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CUC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CUP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CVE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CZK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DJF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DKK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/EGP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ERN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ETB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/EUR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/FJD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/FKP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GBP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GEL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GHS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GIP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GNF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GTQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HKD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HNL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HRK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HTG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HUF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/IDR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ILS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/INR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/IQD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/IRR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ISK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/JMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/JOD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/JPY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KES", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KGS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KHR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KMF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KPW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KRW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KWD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KZT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LAK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LBP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LKR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LRD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LSL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LTL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LVL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MDL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MGA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MKD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MMK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MNT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MRO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MUR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MVR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MWK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MXN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MXV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MYR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MZN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NGN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NIO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NOK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NPR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/OMR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PAB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PGK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PHP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PKR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PLN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PYG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/QAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RON", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RSD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RUB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RWF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SCR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SDG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SEK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SGD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SHP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SLL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SOS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SRD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SSP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/STD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SVC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SYP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SZL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/THB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TJS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TMT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TRY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TTD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TWD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TZS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UAH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UGX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/USD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/USN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/USS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UYI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UYU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UZS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/VEF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/VND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/VUV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/WST", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XAF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XAG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XAU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XCD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XDR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XFU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XOF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XPD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XPF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XPT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XSU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XTS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XUA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/YER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ZAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ZMW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ZWL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/DECLINED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/CANCELLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/FAILED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/SETTLING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/AUTHORIZED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/SETTLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/PENDING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/FIRST_PAYMENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/ECOMMERCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/SUBSCRIPTION", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/UNSCHEDULED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/MOTO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/IN_STORE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CREDIT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEBIT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/PREPAID", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CHARGE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEFERRED_DEBIT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mx", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mnc", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mcc", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/network", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCountryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/issuerName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCurrencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/regionalRestriction", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/accountNumberType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/accountFundingType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/prepaidReloadableIndicator", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/productUsageType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/productCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object/property/productName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/3DS_AUTHENTICATION", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/USE_PRIMER_SDK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/PAYMENT_METHOD_VOUCHER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/PROCESSOR_3DS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/PRIMARY_ACCOUNT_NUMBER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/NETWORK_TOKEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/AMEX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/DANKORT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/DINERS_CLUB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/DISCOVER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/ENROUTE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/ELO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/HIPER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/INTERAC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/JCB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/MAESTRO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/MASTERCARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/MIR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/PRIVATE_LABEL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/UNIONPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/VISA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape/enum/value/OTHER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardProductTypeEnum/shape/enum/value/CONSUMER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardProductTypeEnum/shape/enum/value/BUSINESS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardProductTypeEnum/shape/enum/value/GOVERNMENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardProductTypeEnum/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/DOMESTIC_USE_ONLY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/NONE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema/shape/object/property/lineItems", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema/shape/object/property/countryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema/shape/object/property/retailerCountryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema/shape/object/property/fees", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema/shape/object/property/shipping", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderFeesApiSchema/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderFeesApiSchema/shape/object/property/type", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderFeesApiSchema/shape/object/property/description", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/itemId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/name", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/description", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/quantity", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/discountAmount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxAmount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/productType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/productData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/sku", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/brand", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/color", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/globalTradeItemNumber", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/manufacturerPartNumber", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/weight", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/weightUnit", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderShippingApiSchema/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/PAYMENT_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/vaultOn3DS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/orderedAllowedCardNetworks", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/options", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/authorizationType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object/property/surcharge", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object/property/extraMerchantData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object/property/networks", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/AMEX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DANKORT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DINERS_CLUB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DISCOVER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ENROUTE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ELO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/HIPER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/INTERAC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/JCB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MAESTRO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MASTERCARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MIR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/PRIVATE_LABEL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/UNIONPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/VISA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/OTHER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object/property/surcharge", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/vaultOn3DS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/authorizationType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/3", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/4", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/5", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/6", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/7", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/isVaulted", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/analyticsId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/threeDSecureAuthentication", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/authorizationType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/emailAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/mobileNumber", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/firstName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/lastName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/billingAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/shippingAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/taxId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/emailAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/mobileNumber", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/firstName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/lastName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/billingAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/shippingAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/taxId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/clientToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/clientTokenExpirationDate", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/customer", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/warnings", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/customer", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/type", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/code", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/message", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/AZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/BW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/CZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/DE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/DJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/DM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/DK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/DO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/DZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/EC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/EG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/EH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ES", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/EE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ET", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/FI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/FJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/FK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/FR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/FO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/FM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/HK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/HM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/HN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/HR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/HT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/HU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ID", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/IT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/JM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/JE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/JO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/JP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/LV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ML", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ME", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/MY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/YT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/NZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/OM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/KP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/QA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/RE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/RO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/RU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/RW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/GS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/PM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/RS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ST", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/SY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/TZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/UG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/UA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/UM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/UY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/US", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/UZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/VA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/VC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/VE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/VG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/VI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/VN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/VU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/WF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/WS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/YE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ZA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ZM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape/enum/value/ZW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/AED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/AFN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ALL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/AMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ANG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/AOA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ARS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/AUD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/AWG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/AZN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BAM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BDT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BGN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BHD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BIF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BOB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BOV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BRL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BSD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BTN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BWP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BYR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BYN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/BZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CDF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CHE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CHF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CHW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CLF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CLP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CNY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/COP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/COU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CRC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CUC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CUP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CVE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/CZK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/DJF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/DKK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/DOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/DZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/EGP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ERN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ETB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/EUR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/FJD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/FKP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GBP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GEL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GHS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GIP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GNF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GTQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/GYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/HKD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/HNL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/HRK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/HTG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/HUF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/IDR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ILS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/INR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/IQD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/IRR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ISK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/JMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/JOD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/JPY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KES", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KGS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KHR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KMF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KPW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KRW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KWD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/KZT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LAK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LBP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LKR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LRD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LSL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LTL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LVL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/LYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MDL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MGA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MKD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MMK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MNT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MRO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MUR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MVR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MWK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MXN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MXV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MYR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/MZN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/NAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/NGN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/NIO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/NOK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/NPR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/NZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/OMR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/PAB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/PEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/PGK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/PHP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/PKR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/PLN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/PYG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/QAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/RON", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/RSD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/RUB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/RWF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SCR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SDG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SEK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SGD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SHP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SLL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SOS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SRD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SSP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/STD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SVC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SYP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/SZL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/THB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TJS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TMT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TRY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TTD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TWD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/TZS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/UAH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/UGX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/USD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/USN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/USS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/UYI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/UYU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/UZS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/VEF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/VND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/VUV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/WST", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XAF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XAG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XAU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XBA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XBB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XBC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XCD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XDR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XFU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XOF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XPD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XPF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XPT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XSU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XTS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/XUA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/YER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ZAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ZMW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape/enum/value/ZWL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/name", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/processorMerchantId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountCaptured", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountRefunded", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:GoCardlessMandateApiSchema/shape/object/property/gocardlessMandateId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:IdealPayNlTokenApiSchema/shape/object/property/paymentMethodConfigId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/title", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/firstName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/lastName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/email", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/phoneNumber", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine1", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine2", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine3", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/city", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/state", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/countryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/postalCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/klarnaCustomerToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/sessionData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/klarnaAuthorizationToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/sessionData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/recurringDescription", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/billingAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/shippingAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCountry", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCurrency", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/locale", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/orderLines", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/tokenDetails", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaTokenDetails/shape/object/property/type", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaTokenDetails/shape/object/property/brand", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaTokenDetails/shape/object/property/masked_number", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaTokenDetails/shape/object/property/expiry_date", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalBillingAgreementId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/externalPayerInfo", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/shippingAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalStatus", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/externalPayerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/email", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/firstName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/lastName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalOrderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/externalPayerInfo", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalStatus", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/date", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/dateUpdated", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/status", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/cardTokenType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/customer", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/processor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/requiredAction", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/statusReason", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/transactions", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object/property/riskData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/first6Digits", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/last4Digits", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationMonth", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationYear", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/cardholderName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/network", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/isNetworkTokenized", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/binData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:StatusReasonApiSchema/shape/object/property/type", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:StatusReasonApiSchema/shape/object/property/declineType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:StatusReasonApiSchema/shape/object/property/code", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:StatusReasonApiSchema/shape/object/property/message", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskDataApiSchema/shape/object/property/fraudChecks", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskDataApiSchema/shape/object/property/cvvCheck", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskDataApiSchema/shape/object/property/avsCheck", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudCheckApiSchema/shape/object/property/source", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudCheckApiSchema/shape/object/property/preAuthorizationResult", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudCheckApiSchema/shape/object/property/postAuthorizationResult", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/ACCEPT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/REFUSE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/FAILED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/THREE_DS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CvvCheckApiSchema/shape/object/property/source", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CvvCheckApiSchema/shape/object/property/result", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsCheckApiSchema/shape/object/property/source", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsCheckApiSchema/shape/object/property/result", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/streetAddress", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/postalCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/MATCHED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_MATCHED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_VERIFIED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_PROVIDED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_APPLICABLE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/SKIPPED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYMENT_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYPAL_ORDER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYPAL_BILLING_AGREEMENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/GOCARDLESS_MANDATE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/KLARNA_AUTHORIZATION_TOKEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/KLARNA_CUSTOMER_TOKEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_IDEAL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APAYA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/OFF_SESSION_PAYMENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/CARD_OFF_SESSION_PAYMENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APPLE_PAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APPLE_PAY_ENCRYPTED_TOKEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/GOOGLE_PAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentListApiResponse/shape/object/property/data", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentListApiResponse/shape/object/property/nextCursor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentListApiResponse/shape/object/property/prevCursor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/name", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/description", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/clientToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/date", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/dateUpdated", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/status", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/processor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape/object/property/processorMerchantId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape/object/property/name", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/name", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/processorMerchantId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/RELOADABLE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NON_RELOADABLE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NOT_APPLICABLE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/FIRST_PAYMENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/ECOMMERCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/SUBSCRIPTION", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/UNSCHEDULED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ProductTypeEnum/shape/enum/value/PHYSICAL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ProductTypeEnum/shape/enum/value/DIGITAL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/NOT_PERFORMED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/SKIPPED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_SUCCESS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_FAILED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/CHALLENGE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/METHOD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/responseCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonText", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/protocolVersion", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/challengeIssued", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REJECTED_BY_ISSUER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARD_AUTHENTICATION_FAILED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN_DEVICE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNSUPPORTED_DEVICE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXPIRED_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_CARD_NUMBER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_TRANSACTION", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NO_CARD_RECORD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SECURITY_FAILURE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/STOLEN_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SUSPECTED_FRAUD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARDHOLDER_NOT_ENROLLED_IN_SERVICE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_TIMED_OUT_AT_THE_ACS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/LOW_CONFIDENCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/MEDIUM_CONFIDENCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/HIGH_CONFIDENCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/VERY_HIGH_CONFIDENCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_ACS_MAXIMUM_CHALLENGES", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NON_PAYMENT_NOT_SUPPORTED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/THREE_RI_NOT_SUPPORTED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TECHNICAL_ISSUE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_REQUIRED_BY_ACS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_MAX_EXPIRY_EXCEEDED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TIMED_OUT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_ACS_RESPONSE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_SYSTEM_ERROR_RESPONSE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ERROR_GENERATING_CAVV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/PROTOCOL_VERSION_NOT_SUPPORTED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REQUESTED_PROGRAM_NOT_SUPPORTED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/GATEWAY_UNAVAILABLE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/DISABLED_BY_MERCHANT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/NOT_SUPPORTED_BY_ISSUER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/FAILED_TO_NEGOTIATE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/UNKNOWN_ACS_RESPONSE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/3DS_SERVER_ERROR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_CONFIGURED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_PARTICIPATING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TokenTypeEnum/shape/enum/value/MULTI_USE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TokenTypeEnum/shape/enum/value/SINGLE_USE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:DeclineTypeEnum/shape/enum/value/SOFT_DECLINE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:DeclineTypeEnum/shape/enum/value/HARD_DECLINE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ERROR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INVALID_CARD_NUMBER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/EXPIRED_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/LOST_OR_STOLEN_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/SUSPECTED_FRAUD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DECLINED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/REFER_TO_CARD_ISSUER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DO_NOT_HONOR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INSUFFICIENT_FUNDS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/AUTHENTICATION_REQUIRED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/date", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/transactionType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorTransactionId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorMerchantId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatus", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatusReason", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/cardTokenType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/PENDING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/FAILED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/AUTHORIZED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/SETTLING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/SETTLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/DECLINED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape/enum/value/CANCELLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/APPLICATION_ERROR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/GATEWAY_REJECTED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/ISSUER_DECLINED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionTypeEnum/shape/enum/value/SALE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionTypeEnum/shape/enum/value/REFUND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/firstName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/lastName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine1", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine2", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/city", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/state", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/countryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object/property/postalCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/firstName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/lastName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/addressLine1", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/addressLine2", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/city", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/state", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/countryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object/property/postalCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/3", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/4", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/createdAt", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deletedAt", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deleted", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/token", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/tokenType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/analyticsId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/description", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/default", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape/object/property/isVerified", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape/object/property/data", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/connectionId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/connectionName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/balance", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyTransactionTypeEnum/shape/enum/value/REDEMPTION", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyTransactionTypeEnum/shape/enum/value/REFUND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/date", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/connectionId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/customerId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/orderId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/connectionTransactionId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/connectionName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/type", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/value", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/items", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/total", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/limit", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/offset", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ES", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ET", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ID", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ML", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ME", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/YT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/OM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/QA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ST", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/US", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/WF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/WS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/YE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ZA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ZM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ZW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData/shape/object/property/network", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData/shape/object/property/issuerCountryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData/shape/object/property/issuerName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData/shape/object/property/productUsageType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData/shape/object/property/accountFundingType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ES", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ET", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ID", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ML", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ME", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/YT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/OM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/QA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ST", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TJ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/US", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UZ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/WF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/WS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/YE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ZA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ZM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ZW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrder/shape/object/property/id", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrder/shape/object/property/countryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AFN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ALL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ANG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AOA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ARS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AUD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AWG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AZN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BAM", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BDT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BGN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BHD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BIF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BOB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BOV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BRL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BSD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BTN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BWP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BYR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BYN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CDF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CHE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CHF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CHW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CLF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CLP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CNY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/COP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/COU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CRC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CUC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CUP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CVE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CZK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DJF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DKK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/EGP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ERN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ETB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/EUR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/FJD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/FKP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GBP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GEL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GHS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GIP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GNF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GTQ", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HKD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HNL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HRK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HTG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HUF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/IDR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ILS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/INR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/IQD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/IRR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ISK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/JMD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/JOD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/JPY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KES", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KGS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KHR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KMF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KPW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KRW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KWD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KZT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LAK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LBP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LKR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LRD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LSL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LTL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LVL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MDL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MGA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MKD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MMK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MNT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MRO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MUR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MVR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MWK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MXN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MXV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MYR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MZN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NAD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NGN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NIO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NOK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NPR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NZD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/OMR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PAB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PGK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PHP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PKR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PLN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PYG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/QAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RON", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RSD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RUB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RWF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SCR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SDG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SEK", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SGD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SHP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SLL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SOS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SRD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SSP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/STD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SVC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SYP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SZL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/THB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TJS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TMT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TOP", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TRY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TTD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TWD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TZS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UAH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UGX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/USD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/USN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/USS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UYI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UYU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UZS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/VEF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/VND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/VUV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/WST", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XAF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XAG", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XAU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBB", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBC", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XCD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XDR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XFU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XOF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XPD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XPF", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XPT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XSU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XTS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XUA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/YER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ZAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ZMW", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ZWL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/DECLINED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/CANCELLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/FAILED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/SETTLING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/AUTHORIZED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/SETTLED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/PENDING", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/FIRST_PAYMENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/ECOMMERCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/SUBSCRIPTION", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/UNSCHEDULED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/MOTO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/IN_STORE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/paymentId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/currencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/processor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/amount", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/createdAt", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/order", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/status", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/statusReason", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/paymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/metadata", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/paymentType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object/property/descriptor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object/property/paymentMethodType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object/property/data", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object/property/threeDSecureAuthentication", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethodData/shape/object/property/binData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethodData/shape/object/property/first6Digits", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/APAYA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ADYEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/AFTERPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/AIRWALLEX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ALIANT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ALIPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ATOME", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BANKED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BARCLAYCARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BRAINTREE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BUCKAROO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BRIDGE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CHAI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CHECKOUT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CLEARPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/COINBASE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CYBERSOURCE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/DLOCAL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/EBANX", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ECOSPEND", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/FINTECTURE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/GLOBAL_PAYMENTS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/HOOLAH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/INGENICO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/INGENICO-CONNECT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/KLARNA", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/LAYBUY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/MPGS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/MOLLIE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NEONOMICS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NEXI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NUVEI", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/OMISE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/OPENNODE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAY_NL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAY-NL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAYGENT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAYPAL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PRIMER_TEST", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/STRIPE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRILO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRUELAYER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/VOLT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/VYNE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/WORLDPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/EMERCHANTPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/XFERS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/RAPYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/AUTHNET", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NETS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NETAXEPT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PRIMER_PROCESSOR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/REACH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRUST_PAYMENTS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TWOC2P", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/MERCADO_PAGO", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAYU", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/XENDIT", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/FISERV", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PACYPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/SHOPEEPAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRIPLE_A", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/IPAY88", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/APPLE_PAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/GOOGLE_PAY", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/RISKIFIED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TAXJAR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/STITCH", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/SIGNIFYD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessor/shape/object/property/name", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessor/shape/object/property/merchantId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonType/shape/enum/value/APPLICATION_ERROR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonType/shape/enum/value/GATEWAY_REJECTED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonType/shape/enum/value/ISSUER_DECLINED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonDeclineType/shape/enum/value/SOFT_DECLINE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonDeclineType/shape/enum/value/HARD_DECLINE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/ERROR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/INVALID_CARD_NUMBER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/EXPIRED_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/LOST_OR_STOLEN_CARD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/SUSPECTED_FRAUD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/UNKNOWN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/DECLINED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/REFER_TO_CARD_ISSUER", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/DO_NOT_HONOR", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/INSUFFICIENT_FUNDS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/AUTHENTICATION_REQUIRED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/type", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/declineType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/code", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/message", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/NOT_PERFORMED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/SKIPPED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/AUTH_SUCCESS", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/AUTH_FAILED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/CHALLENGE", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/METHOD", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/transStatus", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/transStatusReason", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/responseCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/challengeIssued", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/protocolVersion", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/reasonCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/reasonText", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/eci", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ErrorObject/shape/object/property/errorId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ErrorObject/shape/object/property/description", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ErrorObject/shape/object/property/diagnosticsId", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ErrorObject/shape/object/property/validationErrors", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_ErrorResponse/shape/object/property/error", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_four_ErrorResponse/shape/object/property/error", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_nine_ErrorResponse/shape/object/property/error", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape/object/property/error", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/ESTIMATED", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/FINAL", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardTokenTypeEnum/shape/enum/value/CARD_PAN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardTokenTypeEnum/shape/enum/value/NETWORK_TOKEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardTokenTypeEnum/shape/enum/value/PROCESSOR_TOKEN", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/error/0/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/1/404/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/2/409/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/3/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/error/1/404/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/error/2/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/response", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/0/400/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/1/422/error/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionExtraMerchantDataApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringPaymentTypeSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderFeesApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderShippingApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWarningsApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:GoCardlessMandateApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:IdealPayNlTokenApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaTokenDetails/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalOrderTokenApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:StatusReasonApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskDataApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudCheckApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CvvCheckApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsCheckApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsRiskAssessmentValues/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentListApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequiredActionApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiBalanceResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrder/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethodData/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessor/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReason/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ErrorObject/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_ErrorResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_four_ErrorResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_nine_ErrorResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape/object", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BlockingPaymentActionTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardAccountNumberTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardProductTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardRegionRestrictionEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionExtraMerchantDataApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudDecisionTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PrepaidReloadableEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringTransactionTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringPaymentTypeSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ProductTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TokenTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:DeclineTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatusTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyTransactionTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonType/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonDeclineType/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AuthorizationTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardTokenTypeEnum/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/error/0/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/1/404", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/2/409", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/error/3/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/3", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/example/4", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/error/1/404", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/error/2/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/example/3", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/0/400", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/1/422", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/0", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/1", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/2", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AccountFundingTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ApayaCustomerTokenApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BlockingPaymentActionTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardAccountNumberTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardNetworkEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardProductTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardRegionRestrictionEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderFeesApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderShippingApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWarningsApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CountryCodeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:Currency", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponseProcessorApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:GoCardlessMandateApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:IdealPayNlTokenApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaCustomerTokenApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaPaymentSessionApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaTokenDetails/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalBillingAgreementApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalOrderTokenApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:StatusReasonApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskDataApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudCheckApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudDecisionTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CvvCheckApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsCheckApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsRiskAssessmentValues/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskAssessmentStatusEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentMethodTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentListApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequiredActionApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryProcessorApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PrepaidReloadableEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RecurringTransactionTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ProductTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthResponseCodeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureFailedReasonCodeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TokenTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:DeclineTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionDeclineReasonV2Enum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatus", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentStatusTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiBalanceResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyTransactionTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionsListResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrderCountryCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrder/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentCurrencyCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentStatus", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentPaymentType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethod/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethodData/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessorName", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessor/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonDeclineType", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReasonCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReason/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ErrorObject/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_ErrorResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_four_ErrorResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_nine_ErrorResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AuthorizationTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CardTokenTypeEnum", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ApayaCustomerTokenApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:BinDataApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderDetailsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderFeesApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderLineItemsProductDataApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OrderShippingApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CheckoutCustomerDetailsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CustomerDetailsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWithTokenApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ClientSessionWarningsApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentResponseProcessorApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:GoCardlessMandateApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:IdealPayNlTokenApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaAddressApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaCustomerTokenApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaPaymentSessionApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaSessionDetailsApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:KlarnaTokenDetails", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalBillingAgreementApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalExternalPayerInfoApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PayPalOrderTokenApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentCardTokenApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:StatusReasonApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:RiskDataApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:FraudCheckApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:CvvCheckApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsCheckApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AvsRiskAssessmentValues", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentListApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentRequiredActionApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentSummaryProcessorApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ThreeDSecureAuthenticationApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:TransactionOverviewApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:OptionalAddressApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:AddressApiSchema", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:MerchantPaymentMethodTokenApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiBalanceResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:LoyaltyApiTransactionsListResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsBinData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsOrder", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPayment", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethod", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsPaymentMethodData", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsProcessor", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsStatusReason", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:ErrorObject", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_ErrorResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_four_ErrorResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_nine_ErrorResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/type-definition/type_:four_hundred_twenty_two_ErrorResponse", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.retrieveClientSideToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.createClientSideToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_clientSessionApi.updateClientSideToken", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.listPayments", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.createPayment", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.authorizePayment", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.capturePayment", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.cancelPayment", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.refundPayment", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.resumePayment", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.adjustAuthorization", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentsApi.getPaymentById", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_observabilityApiBeta.external_payment_update", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions", + "090e0b31-c453-4f41-8269-845a6e8a461f/endpoint/subpackage_loyaltyApi.post_loyalty_transaction" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-0d20b529-65ad-4f2b-99a5-562a73e0b3c9.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-0d20b529-65ad-4f2b-99a5-562a73e0b3c9.json new file mode 100644 index 0000000000..f9880bc8b0 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-0d20b529-65ad-4f2b-99a5-562a73e0b3c9.json @@ -0,0 +1,2656 @@ +[ + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/query/clientToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customer", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/clientToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/customer", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/status", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/payment_method_type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/processor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/currency_code", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/from_date", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/to_date", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/order_id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/min_amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/max_amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/customer_id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/merchant_id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/customer_email_address", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/last_4_digits", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/paypal_email", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/klarna_email", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/limit", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/query/cursor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/requestHeader/X-Idempotency-Key", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethodToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customer", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/requestHeader/X-Idempotency-Key", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/request/object/property/processor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/3/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/4/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/requestHeader/X-Idempotency-Key", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/final", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/3/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/requestHeader/X-Idempotency-Key", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/request/object/property/reason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/requestHeader/X-Idempotency-Key", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/reason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/3/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/request/object/property/resumeToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/requestHeader/X-Idempotency-Key", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/request/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/3/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/4/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/path/paymentMethodToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/query/customer_id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/path/paymentMethodToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/path/paymentMethodToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/path/paymentId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/paymentId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/processor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/createdAt", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/status", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/statusReason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/paymentType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object/property/descriptor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/path/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/query/connectionId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/connectionId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/limit", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/query/offset", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/connectionId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object/property/value", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/0/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/1/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/2/snippet/curl/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder/shape/object/property/retailerCountryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AFN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ALL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ANG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AOA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ARS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AUD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AWG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/AZN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BAM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BDT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BGN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BHD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BIF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BOB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BOV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BRL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BSD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BTN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BWP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BYR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BYN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/BZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CDF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CHE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CHF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CHW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CLF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CLP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CNY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/COP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/COU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CRC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CUC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CUP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CVE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/CZK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DJF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DKK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/DZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/EGP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ERN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ETB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/EUR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/FJD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/FKP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GBP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GEL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GHS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GIP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GNF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GTQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/GYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HKD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HNL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HRK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HTG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/HUF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/IDR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ILS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/INR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/IQD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/IRR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ISK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/JMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/JOD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/JPY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KES", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KGS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KHR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KMF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KPW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KRW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KWD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/KZT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LAK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LBP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LKR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LRD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LSL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LTL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LVL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/LYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MDL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MGA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MKD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MMK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MNT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MRO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MUR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MVR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MWK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MXN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MXV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MYR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/MZN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NGN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NIO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NOK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NPR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/NZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/OMR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PAB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PEN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PGK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PHP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PKR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PLN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/PYG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/QAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RON", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RSD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RUB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/RWF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SCR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SDG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SEK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SGD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SHP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SLL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SOS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SRD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SSP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/STD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SVC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SYP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/SZL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/THB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TJS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TMT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TRY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TTD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TWD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/TZS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UAH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UGX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/USD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/USN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/USS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UYI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UYU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/UZS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/VEF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/VND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/VUV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/WST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XAF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XAG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XAU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XCD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XDR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XFU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XOF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XPD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XPF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XPT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XSU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XTS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/XUA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/YER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ZAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ZMW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape/enum/value/ZWL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/DECLINED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/CANCELLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/FAILED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/SETTLING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/AUTHORIZED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/SETTLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape/enum/value/PENDING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/FIRST_PAYMENT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/ECOMMERCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/SUBSCRIPTION", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/UNSCHEDULED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/MOTO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape/enum/value/IN_STORE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CREDIT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEBIT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/PREPAID", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CHARGE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEFERRED_DEBIT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mx", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mnc", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mcc", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/network", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCountryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/issuerName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCurrencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/regionalRestriction", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/accountNumberType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/accountFundingType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/prepaidReloadableIndicator", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/productUsageType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/productCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object/property/productName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/3DS_AUTHENTICATION", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/USE_PRIMER_SDK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/PAYMENT_METHOD_VOUCHER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/PROCESSOR_3DS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/PRIMARY_ACCOUNT_NUMBER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/NETWORK_TOKEN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/AMEX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/DANKORT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/DINERS_CLUB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/DISCOVER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/ENROUTE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/ELO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/HIPER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/INTERAC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/JCB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/MAESTRO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/MASTERCARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/MIR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/PRIVATE_LABEL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/UNIONPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/VISA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape/enum/value/OTHER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardProductTypeEnum/shape/enum/value/CONSUMER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardProductTypeEnum/shape/enum/value/BUSINESS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardProductTypeEnum/shape/enum/value/GOVERNMENT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardProductTypeEnum/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/DOMESTIC_USE_ONLY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/NONE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema/shape/object/property/lineItems", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema/shape/object/property/countryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema/shape/object/property/retailerCountryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema/shape/object/property/fees", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema/shape/object/property/shipping", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderFeesApiSchema/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderFeesApiSchema/shape/object/property/type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderFeesApiSchema/shape/object/property/description", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/itemId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/name", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/description", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/quantity", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/discountAmount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxAmount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/productType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/productData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/sku", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/brand", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/color", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/globalTradeItemNumber", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/manufacturerPartNumber", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/weight", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object/property/weightUnit", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderShippingApiSchema/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/PAYMENT_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/vaultOn3DS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/orderedAllowedCardNetworks", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/options", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/authorizationType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object/property/surcharge", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object/property/networks", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/AMEX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DANKORT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DINERS_CLUB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DISCOVER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ENROUTE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ELO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/HIPER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/INTERAC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/JCB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MAESTRO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MASTERCARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MIR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/PRIVATE_LABEL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/UNIONPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/VISA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/OTHER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object/property/surcharge", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/vaultOn3DS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/authorizationType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/3", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/4", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/5", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/6", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/7", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/isVaulted", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/analyticsId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/threeDSecureAuthentication", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/authorizationType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/emailAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/mobileNumber", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/firstName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/lastName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/billingAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/shippingAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/taxId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/emailAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/mobileNumber", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/firstName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/lastName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/billingAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/shippingAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/taxId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/clientToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/clientTokenExpirationDate", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/customer", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/warnings", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/customer", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/code", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/message", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/AZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/BW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/CZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/DE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/DJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/DM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/DK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/DO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/DZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/EC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/EG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/EH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ES", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/EE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ET", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/FI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/FJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/FK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/FR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/FO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/FM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/HK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/HM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/HN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/HR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/HT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/HU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ID", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/IT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/JM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/JE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/JO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/JP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/LV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ML", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ME", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/MY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/YT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/NZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/OM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/KP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/QA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/RE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/RO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/RU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/RW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/GS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/PM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/RS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/SY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/TZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/UG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/UA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/UM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/UY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/US", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/UZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/VA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/VC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/VE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/VG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/VI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/VN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/VU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/WF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/WS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/YE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ZA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ZM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape/enum/value/ZW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/AED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/AFN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ALL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/AMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ANG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/AOA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ARS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/AUD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/AWG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/AZN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BAM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BDT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BGN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BHD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BIF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BOB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BOV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BRL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BSD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BTN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BWP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BYR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BYN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/BZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CDF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CHE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CHF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CHW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CLF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CLP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CNY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/COP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/COU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CRC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CUC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CUP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CVE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/CZK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/DJF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/DKK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/DOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/DZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/EGP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ERN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ETB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/EUR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/FJD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/FKP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GBP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GEL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GHS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GIP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GNF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GTQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/GYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/HKD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/HNL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/HRK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/HTG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/HUF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/IDR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ILS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/INR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/IQD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/IRR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ISK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/JMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/JOD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/JPY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KES", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KGS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KHR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KMF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KPW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KRW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KWD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/KZT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LAK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LBP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LKR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LRD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LSL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LTL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LVL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/LYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MDL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MGA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MKD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MMK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MNT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MRO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MUR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MVR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MWK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MXN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MXV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MYR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/MZN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/NAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/NGN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/NIO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/NOK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/NPR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/NZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/OMR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/PAB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/PEN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/PGK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/PHP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/PKR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/PLN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/PYG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/QAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/RON", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/RSD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/RUB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/RWF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SCR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SDG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SEK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SGD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SHP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SLL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SOS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SRD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SSP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/STD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SVC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SYP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/SZL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/THB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TJS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TMT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TRY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TTD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TWD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/TZS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/UAH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/UGX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/USD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/USN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/USS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/UYI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/UYU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/UZS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/VEF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/VND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/VUV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/WST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XAF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XAG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XAU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XBA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XBB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XBC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XCD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XDR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XFU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XOF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XPD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XPF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XPT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XSU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XTS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/XUA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/YER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ZAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ZMW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape/enum/value/ZWL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/name", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/processorMerchantId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountCaptured", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountRefunded", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:GoCardlessMandateApiSchema/shape/object/property/gocardlessMandateId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:IdealPayNlTokenApiSchema/shape/object/property/paymentMethodConfigId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/title", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/firstName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/lastName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/email", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/phoneNumber", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine3", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/city", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/state", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/countryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/postalCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/klarnaCustomerToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/sessionData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/klarnaAuthorizationToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/sessionData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/recurringDescription", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/billingAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/shippingAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCountry", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCurrency", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/locale", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/orderLines", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/tokenDetails", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaTokenDetails/shape/object/property/type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaTokenDetails/shape/object/property/brand", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaTokenDetails/shape/object/property/masked_number", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaTokenDetails/shape/object/property/expiry_date", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalBillingAgreementId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/externalPayerInfo", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/shippingAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalStatus", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/externalPayerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/email", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/firstName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/lastName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalOrderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/externalPayerInfo", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalStatus", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/date", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/dateUpdated", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/status", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/cardTokenType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/customer", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/processor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/requiredAction", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/statusReason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/transactions", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object/property/riskData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/first6Digits", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/last4Digits", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationMonth", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationYear", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/cardholderName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/network", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/isNetworkTokenized", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/binData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:StatusReasonApiSchema/shape/object/property/type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:StatusReasonApiSchema/shape/object/property/declineType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:StatusReasonApiSchema/shape/object/property/code", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:StatusReasonApiSchema/shape/object/property/message", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskDataApiSchema/shape/object/property/fraudChecks", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskDataApiSchema/shape/object/property/cvvCheck", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskDataApiSchema/shape/object/property/avsCheck", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudCheckApiSchema/shape/object/property/source", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudCheckApiSchema/shape/object/property/preAuthorizationResult", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudCheckApiSchema/shape/object/property/postAuthorizationResult", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/ACCEPT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/REFUSE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/FAILED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/THREE_DS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CvvCheckApiSchema/shape/object/property/source", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CvvCheckApiSchema/shape/object/property/result", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsCheckApiSchema/shape/object/property/source", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsCheckApiSchema/shape/object/property/result", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/streetAddress", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/postalCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/MATCHED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_MATCHED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_VERIFIED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_PROVIDED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_APPLICABLE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/SKIPPED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYMENT_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/GOOGLE_PAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APPLE_PAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYPAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/BANK_ACCOUNT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/KLARNA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APAYA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/OPENNODE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/HOOLAH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ATOME", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/COINBASE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/NETS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/TWOC2P", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/CLEARPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/SHOPEEPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/TRIPLE_A", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/AFTERPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/NOL_PAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_IDEAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_BANCONTACT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_DIRECT_DEBIT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_SOFORT_BANKING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_PAYPAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_PAYCONIQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_GIROPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_P24", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_EPS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_KAARTDIRECT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_SOFORT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_TWINT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_GIROPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_TRUSTLY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_ALIPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_MOBILEPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_MULTIBANCO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_VIPPS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_DOTPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_IDEAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_BLIK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_PAYTRAIL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_INTERAC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_PAYSHOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_MBWAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_AFFIRM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_KLARNA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_BANCONTACT_PAYCONIQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_EPS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_BANCONTACT_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ADYEN_SWISH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MOLLIE_IDEAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MOLLIE_BANCONTACT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MOLLIE_P24", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MOLLIE_GIROPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MOLLIE_EPS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MOLLIE_GIFTCARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MOLLIE_SOFORT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/NETAXEPT_PAYTRAIL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/BUCKAROO_IDEAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/BUCKAROO_BANCONTACT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/BUCKAROO_SOFORT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/BUCKAROO_GIROPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/BUCKAROO_EPS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/RAPYD_GCASH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/RAPYD_PROMPTPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/RAPYD_GRABPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/RAPYD_POLI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/RAPYD_FAST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/XFERS_PAYNOW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/STRIPE_GIROPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/STRIPE_IDEAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/ALIPAY_CN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/CHAI_KAKAOPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/CHAI_NAVER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/CHAI_TOSS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/XENDIT_DANA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/XENDIT_OVO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/XENDIT_SHOPEEPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/XENDIT_RETAIL_OUTLETS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/OMISE_PROMPTPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/OMISE_TRUEMONEY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/EBANX_PAGOFACIL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PACYPAY_WECHAT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PACYPAY_ALIPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PACYPAY_ALIPAY_PLUS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/WORLDPAY_IDEAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/IPAY88_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/INGENICO_PAYPAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/VOLT_PIX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/VOLT_BANK_TRANSFER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/BRAINTREE_VENMO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/THUNES_SPIRIT_OF_CADEAU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/THUNES_ILLICADO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/THUNES_CARTE_CADEAU_CONFORAMA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/THUNES_CHEQUE_FIDELITE_CONFORAMA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/SIPS_CPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/SIPS_CPAYCONFORAMA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MONEXT_CETELEM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/MONEXT_CPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentListApiResponse/shape/object/property/data", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentListApiResponse/shape/object/property/nextCursor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentListApiResponse/shape/object/property/prevCursor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/name", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/description", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/clientToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/date", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/dateUpdated", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/status", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/processor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape/object/property/processorMerchantId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape/object/property/name", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/name", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/processorMerchantId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/RELOADABLE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NON_RELOADABLE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NOT_APPLICABLE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/FIRST_PAYMENT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/ECOMMERCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/SUBSCRIPTION", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/UNSCHEDULED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ProductTypeEnum/shape/enum/value/PHYSICAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ProductTypeEnum/shape/enum/value/DIGITAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/NOT_PERFORMED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/SKIPPED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_SUCCESS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_FAILED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/CHALLENGE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/METHOD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/responseCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonText", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/protocolVersion", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/challengeIssued", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REJECTED_BY_ISSUER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARD_AUTHENTICATION_FAILED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN_DEVICE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNSUPPORTED_DEVICE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXPIRED_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_CARD_NUMBER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_TRANSACTION", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NO_CARD_RECORD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SECURITY_FAILURE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/STOLEN_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SUSPECTED_FRAUD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARDHOLDER_NOT_ENROLLED_IN_SERVICE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_TIMED_OUT_AT_THE_ACS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/LOW_CONFIDENCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/MEDIUM_CONFIDENCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/HIGH_CONFIDENCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/VERY_HIGH_CONFIDENCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_ACS_MAXIMUM_CHALLENGES", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NON_PAYMENT_NOT_SUPPORTED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/THREE_RI_NOT_SUPPORTED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TECHNICAL_ISSUE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_REQUIRED_BY_ACS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_MAX_EXPIRY_EXCEEDED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TIMED_OUT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_ACS_RESPONSE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_SYSTEM_ERROR_RESPONSE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ERROR_GENERATING_CAVV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/PROTOCOL_VERSION_NOT_SUPPORTED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REQUESTED_PROGRAM_NOT_SUPPORTED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/GATEWAY_UNAVAILABLE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/DISABLED_BY_MERCHANT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/NOT_SUPPORTED_BY_ISSUER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/FAILED_TO_NEGOTIATE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/UNKNOWN_ACS_RESPONSE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/3DS_SERVER_ERROR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_CONFIGURED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_PARTICIPATING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TokenTypeEnum/shape/enum/value/MULTI_USE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TokenTypeEnum/shape/enum/value/SINGLE_USE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:DeclineTypeEnum/shape/enum/value/SOFT_DECLINE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:DeclineTypeEnum/shape/enum/value/HARD_DECLINE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ERROR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INVALID_CARD_NUMBER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/EXPIRED_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/LOST_OR_STOLEN_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/SUSPECTED_FRAUD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DECLINED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/REFER_TO_CARD_ISSUER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DO_NOT_HONOR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INSUFFICIENT_FUNDS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/AUTHENTICATION_REQUIRED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/date", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/transactionType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorTransactionId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorMerchantId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatus", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatusReason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/cardTokenType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/PENDING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/FAILED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/AUTHORIZED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/SETTLING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/SETTLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/DECLINED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape/enum/value/CANCELLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/APPLICATION_ERROR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/GATEWAY_REJECTED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/ISSUER_DECLINED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionTypeEnum/shape/enum/value/SALE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionTypeEnum/shape/enum/value/REFUND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/firstName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/lastName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/city", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/state", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/countryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/postalCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/firstName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/lastName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/addressLine1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/addressLine2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/city", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/state", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/countryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object/property/postalCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/3", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/4", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/createdAt", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deletedAt", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deleted", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/token", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/tokenType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/analyticsId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/description", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/default", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape/object/property/isVerified", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape/object/property/data", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/connectionId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/connectionName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiBalanceResponse/shape/object/property/balance", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyTransactionTypeEnum/shape/enum/value/REDEMPTION", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyTransactionTypeEnum/shape/enum/value/REFUND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/date", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/connectionId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/customerId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/orderId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/connectionTransactionId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/connectionName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object/property/value", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/items", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/total", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/limit", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object/property/offset", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/AZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/BW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/CZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/DZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ES", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/EE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ET", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/FM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/HU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ID", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/IT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/JP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/LV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ML", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ME", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/MY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/YT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/NZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/OM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/KP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/QA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/GS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/PM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/RS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/SY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/TZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/US", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/UZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/VU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/WF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/WS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/YE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ZA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ZM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape/enum/value/ZW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData/shape/object/property/network", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData/shape/object/property/issuerCountryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData/shape/object/property/issuerName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData/shape/object/property/productUsageType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData/shape/object/property/accountFundingType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/AZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/BW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/CZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/DZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ES", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/EE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ET", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/FM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/HU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ID", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/IT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/JP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/LV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ML", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ME", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/MY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/YT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/NZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/OM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/KP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/QA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/GS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/PM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/RS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/SY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TJ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/TZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/US", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/UZ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/VU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/WF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/WS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/YE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ZA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ZM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape/enum/value/ZW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrder/shape/object/property/id", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrder/shape/object/property/countryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AFN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ALL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ANG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AOA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ARS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AUD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AWG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/AZN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BAM", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BDT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BGN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BHD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BIF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BOB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BOV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BRL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BSD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BTN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BWP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BYR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BYN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/BZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CDF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CHE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CHF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CHW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CLF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CLP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CNY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/COP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/COU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CRC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CUC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CUP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CVE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/CZK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DJF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DKK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/DZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/EGP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ERN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ETB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/EUR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/FJD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/FKP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GBP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GEL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GHS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GIP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GNF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GTQ", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/GYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HKD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HNL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HRK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HTG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/HUF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/IDR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ILS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/INR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/IQD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/IRR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ISK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/JMD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/JOD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/JPY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KES", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KGS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KHR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KMF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KPW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KRW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KWD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/KZT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LAK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LBP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LKR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LRD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LSL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LTL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LVL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/LYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MDL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MGA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MKD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MMK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MNT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MRO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MUR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MVR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MWK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MXN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MXV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MYR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/MZN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NAD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NGN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NIO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NOK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NPR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/NZD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/OMR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PAB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PEN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PGK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PHP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PKR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PLN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/PYG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/QAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RON", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RSD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RUB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/RWF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SCR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SDG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SEK", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SGD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SHP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SLL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SOS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SRD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SSP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/STD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SVC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SYP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/SZL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/THB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TJS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TMT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TOP", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TRY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TTD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TWD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/TZS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UAH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UGX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/USD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/USN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/USS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UYI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UYU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/UZS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/VEF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/VND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/VUV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/WST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XAF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XAG", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XAU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBB", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBC", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XBD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XCD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XDR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XFU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XOF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XPD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XPF", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XPT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XSU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XTS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/XUA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/YER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ZAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ZMW", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape/enum/value/ZWL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/DECLINED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/CANCELLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/FAILED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/SETTLING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/AUTHORIZED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/SETTLED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape/enum/value/PENDING", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/FIRST_PAYMENT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/ECOMMERCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/SUBSCRIPTION", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/UNSCHEDULED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/MOTO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape/enum/value/IN_STORE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/paymentId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/currencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/processor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/amount", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/createdAt", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/order", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/status", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/statusReason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/paymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/metadata", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/paymentType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object/property/descriptor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object/property/paymentMethodType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object/property/data", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object/property/threeDSecureAuthentication", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethodData/shape/object/property/binData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethodData/shape/object/property/first6Digits", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/APAYA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ADYEN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/AFTERPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/AIRWALLEX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ALIANT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ALIPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ATOME", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BANKED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BARCLAYCARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BRAINTREE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BUCKAROO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/BRIDGE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CHAI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CHECKOUT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CLEARPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/COINBASE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/CYBERSOURCE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/DLOCAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/EBANX", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/ECOSPEND", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/FINTECTURE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/GLOBAL_PAYMENTS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/HOOLAH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/INGENICO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/INGENICO-CONNECT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/KLARNA", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/LAYBUY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/MPGS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/MOLLIE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NEONOMICS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NEXI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NUVEI", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/OMISE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/OPENNODE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAY_NL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAY-NL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAYGENT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAYPAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PRIMER_TEST", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/STRIPE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRILO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRUELAYER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/VOLT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/VYNE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/WORLDPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/EMERCHANTPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/XFERS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/RAPYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/AUTHNET", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NETS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/NETAXEPT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PRIMER_PROCESSOR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/REACH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRUST_PAYMENTS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TWOC2P", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/MERCADO_PAGO", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PAYU", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/XENDIT", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/FISERV", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/PACYPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/SHOPEEPAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TRIPLE_A", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/IPAY88", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/APPLE_PAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/GOOGLE_PAY", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/RISKIFIED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/TAXJAR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/STITCH", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape/enum/value/SIGNIFYD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessor/shape/object/property/name", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessor/shape/object/property/merchantId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonType/shape/enum/value/APPLICATION_ERROR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonType/shape/enum/value/GATEWAY_REJECTED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonType/shape/enum/value/ISSUER_DECLINED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonDeclineType/shape/enum/value/SOFT_DECLINE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonDeclineType/shape/enum/value/HARD_DECLINE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/ERROR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/INVALID_CARD_NUMBER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/EXPIRED_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/LOST_OR_STOLEN_CARD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/SUSPECTED_FRAUD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/UNKNOWN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/DECLINED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/REFER_TO_CARD_ISSUER", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/DO_NOT_HONOR", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/INSUFFICIENT_FUNDS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape/enum/value/AUTHENTICATION_REQUIRED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/type", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/declineType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/code", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReason/shape/object/property/message", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/NOT_PERFORMED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/SKIPPED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/AUTH_SUCCESS", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/AUTH_FAILED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/CHALLENGE", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape/enum/value/METHOD", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/transStatus", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/transStatusReason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/responseCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/challengeIssued", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/protocolVersion", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/reasonCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/reasonText", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object/property/eci", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ErrorObject/shape/object/property/errorId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ErrorObject/shape/object/property/description", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ErrorObject/shape/object/property/diagnosticsId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ErrorObject/shape/object/property/validationErrors", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_ErrorResponse/shape/object/property/error", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_four_ErrorResponse/shape/object/property/error", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponseError/shape/object/property/paymentId", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponseError/shape/object/property/status", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponse/shape/object/property/error", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape/object/property/error", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/ESTIMATED", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/FINAL", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardTokenTypeEnum/shape/enum/value/CARD_PAN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardTokenTypeEnum/shape/enum/value/NETWORK_TOKEN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardTokenTypeEnum/shape/enum/value/PROCESSOR_TOKEN", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/1/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/1/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/error/0/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/error/1/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/1/404/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/2/409/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/3/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/error/1/409/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/error/2/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/error/1/409/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/error/1/409/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/error/2/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/1/404/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/2/409/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/3/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/1/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/1/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/response", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/0/400/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/1/422/error/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringPaymentTypeSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderFeesApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderShippingApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWarningsApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:GoCardlessMandateApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:IdealPayNlTokenApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaTokenDetails/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:StatusReasonApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskDataApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudCheckApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CvvCheckApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsCheckApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsRiskAssessmentValues/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentListApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequiredActionApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiBalanceResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionsListResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrder/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethod/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethodData/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessor/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReason/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ErrorObject/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_ErrorResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_four_ErrorResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponseError/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape/object", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BlockingPaymentActionTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardAccountNumberTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardProductTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardRegionRestrictionEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudDecisionTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PrepaidReloadableEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringTransactionTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringPaymentTypeSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ProductTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TokenTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:DeclineTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatusTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyTransactionTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonType/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonDeclineType/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AuthorizationTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardTokenTypeEnum/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/1/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/1/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/error/0/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/error/1/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/1/404", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/2/409", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/error/3/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/3", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/example/4", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/error/1/409", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/error/2/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/example/3", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/error/1/409", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/error/1/409", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/error/2/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/example/3", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/1/404", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/2/409", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/error/3/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/3", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/example/4", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/1/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/error/1/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/0/400", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/error/1/422", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/0", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/1", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/example/2", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction/request", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AccountFundingTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ApayaCustomerTokenApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BlockingPaymentActionTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardAccountNumberTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardNetworkEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardProductTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardRegionRestrictionEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderFeesApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderShippingApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWarningsApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CountryCodeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:Currency", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponseProcessorApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:GoCardlessMandateApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:IdealPayNlTokenApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaTokenDetails/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalBillingAgreementApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalOrderTokenApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:StatusReasonApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskDataApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudCheckApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudDecisionTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CvvCheckApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsCheckApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsRiskAssessmentValues/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskAssessmentStatusEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentMethodTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentListApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequiredActionApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryProcessorApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PrepaidReloadableEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RecurringTransactionTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ProductTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TokenTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:DeclineTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionDeclineReasonV2Enum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatus", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentStatusTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiBalanceResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyTransactionTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionsListResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinDataIssuerCountryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrderCountryCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrder/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentCurrencyCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentStatus", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentPaymentType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethod/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethodData/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessorName", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessor/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonDeclineType", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReasonCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReason/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ErrorObject/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_ErrorResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_four_ErrorResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponseError/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AuthorizationTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CardTokenTypeEnum", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_paymentsApi:PaymentCaptureApiRequestOrder", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ApayaCustomerTokenApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:BinDataApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderDetailsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderFeesApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderLineItemsProductDataApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OrderShippingApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CheckoutCustomerDetailsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CustomerDetailsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWithTokenApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ClientSessionWarningsApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentResponseProcessorApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:GoCardlessMandateApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:IdealPayNlTokenApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaAddressApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaCustomerTokenApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaPaymentSessionApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaSessionDetailsApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:KlarnaTokenDetails", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalBillingAgreementApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalExternalPayerInfoApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PayPalOrderTokenApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentCardTokenApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:StatusReasonApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:RiskDataApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:FraudCheckApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:CvvCheckApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsCheckApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AvsRiskAssessmentValues", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentListApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentRequiredActionApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentAuthorizationRequestProcessorApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentSummaryProcessorApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ThreeDSecureAuthenticationApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:TransactionOverviewApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:OptionalAddressApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:AddressApiSchema", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:MerchantPaymentMethodTokenApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiBalanceResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:LoyaltyApiTransactionsListResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsBinData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsOrder", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPayment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethod", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsPaymentMethodData", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsProcessor", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsStatusReason", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:PaymentsInsightsThreeDSecureAuthentication", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:ErrorObject", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_ErrorResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_four_ErrorResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponseError", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_nine_ErrorResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/type-definition/type_:four_hundred_twenty_two_ErrorResponse", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.retrieveClientSideToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.createClientSideToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_clientSessionApi.updateClientSideToken", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.listPayments", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.createPayment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.authorizePayment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.capturePayment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.cancelPayment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.refundPayment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.resumePayment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.adjustAuthorization", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentsApi.getPaymentById", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_observabilityApiBeta.external_payment_update", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.get_loyalty_customer_transactions", + "0d20b529-65ad-4f2b-99a5-562a73e0b3c9/endpoint/subpackage_loyaltyApi.post_loyalty_transaction" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-3e1141df-b4bc-4dab-9542-53cf91851645.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-3e1141df-b4bc-4dab-9542-53cf91851645.json new file mode 100644 index 0000000000..03bb896b19 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-3e1141df-b4bc-4dab-9542-53cf91851645.json @@ -0,0 +1,817 @@ +[ + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request/object/property/eventType", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request/object/property/date", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request/object/property/notificationConfig", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request/object/property/version", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request/object/property/signedAt", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request/object/property/payment", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/example/0/snippet/curl/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request/object/property/eventType", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request/object/property/date", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request/object/property/notificationConfig", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request/object/property/version", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request/object/property/signedAt", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request/object/property/payment", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/example/0/snippet/curl/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object/property/eventType", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object/property/processorId", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object/property/processorDisputeId", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object/property/paymentId", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object/property/transactionId", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object/property/orderId", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object/property/primerAccountId", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/example/0/snippet/curl/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadNotificationConfig/shape/object/property/id", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadNotificationConfig/shape/object/property/description", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/id", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/date", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/status", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/orderId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/currencyCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/amount", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/customerId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/metadata", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/paymentMethod", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/processor", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/statusReason", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object/property/transactions", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadNotificationConfig/shape/object/property/id", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadNotificationConfig/shape/object/property/description", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/id", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/date", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/status", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/orderId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/currencyCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/amount", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/customerId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/metadata", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/paymentMethod", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/processor", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/statusReason", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object/property/transactions", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CREDIT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEBIT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/PREPAID", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CHARGE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEFERRED_DEBIT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/UNKNOWN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mx", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mnc", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mcc", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/network", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCountryCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/issuerName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCurrencyCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/regionalRestriction", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/accountNumberType", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/accountFundingType", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/prepaidReloadableIndicator", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/productUsageType", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/productCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object/property/productName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/PRIMARY_ACCOUNT_NUMBER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/NETWORK_TOKEN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/UNKNOWN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardProductTypeEnum/shape/enum/value/CONSUMER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardProductTypeEnum/shape/enum/value/BUSINESS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardProductTypeEnum/shape/enum/value/GOVERNMENT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardProductTypeEnum/shape/enum/value/UNKNOWN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/DOMESTIC_USE_ONLY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/NONE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/UNKNOWN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/1", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/2", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/3", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/4", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/5", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/6", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/7", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodToken", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/analyticsId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodType", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodData", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/threeDSecureAuthentication", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AX", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AQ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/AZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BJ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BQ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/BW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CX", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/CZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/DE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/DJ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/DM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/DK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/DO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/DZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/EC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/EG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/EH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ES", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/EE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ET", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/FI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/FJ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/FK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/FR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/FO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/FM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GQ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/HK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/HM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/HN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/HR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/HT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/HU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ID", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IQ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/IT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/JM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/JE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/JO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/JP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/LV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MX", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ML", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ME", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MQ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/MY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/YT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/NZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/OM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/KP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/QA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/RE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/RO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/RU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/RW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/GS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SJ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/PM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/RS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ST", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SX", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/SY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TJ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/TZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/UG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/UA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/UM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/UY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/US", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/UZ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/VA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/VC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/VE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/VG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/VI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/VN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/VU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/WF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/WS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/YE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ZA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ZM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape/enum/value/ZW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/AED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/AFN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ALL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/AMD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ANG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/AOA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ARS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/AUD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/AWG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/AZN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BAM", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BBD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BDT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BGN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BHD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BIF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BMD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BND", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BOB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BOV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BRL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BSD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BTN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BWP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BYR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BYN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/BZD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CAD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CDF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CHE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CHF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CHW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CLF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CLP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CNY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/COP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/COU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CRC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CUC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CUP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CVE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/CZK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/DJF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/DKK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/DOP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/DZD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/EGP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ERN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ETB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/EUR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/FJD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/FKP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GBP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GEL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GHS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GIP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GMD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GNF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GTQ", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/GYD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/HKD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/HNL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/HRK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/HTG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/HUF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/IDR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ILS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/INR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/IQD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/IRR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ISK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/JMD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/JOD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/JPY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KES", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KGS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KHR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KMF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KPW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KRW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KWD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KYD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/KZT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LAK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LBP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LKR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LRD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LSL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LTL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LVL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/LYD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MAD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MDL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MGA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MKD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MMK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MNT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MOP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MRO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MUR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MVR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MWK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MXN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MXV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MYR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/MZN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/NAD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/NGN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/NIO", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/NOK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/NPR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/NZD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/OMR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/PAB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/PEN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/PGK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/PHP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/PKR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/PLN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/PYG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/QAR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/RON", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/RSD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/RUB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/RWF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SAR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SBD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SCR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SDG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SEK", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SGD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SHP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SLL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SOS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SRD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SSP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/STD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SVC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SYP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/SZL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/THB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TJS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TMT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TND", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TOP", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TRY", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TTD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TWD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/TZS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/UAH", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/UGX", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/USD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/USN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/USS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/UYI", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/UYU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/UZS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/VEF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/VND", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/VUV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/WST", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XAF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XAG", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XAU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XBA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XBB", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XBC", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XBD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XCD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XDR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XFU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XOF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XPD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XPF", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XPT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XSU", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XTS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/XUA", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/YER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ZAR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ZMW", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape/enum/value/ZWL", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/name", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/processorMerchantId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountCaptured", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountRefunded", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:GoCardlessMandateApiSchema/shape/object/property/gocardlessMandateId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:IdealPayNlTokenApiSchema/shape/object/property/paymentMethodConfigId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/title", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/firstName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/lastName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/email", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/phoneNumber", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine1", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine2", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine3", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/city", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/state", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/countryCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/postalCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/klarnaCustomerToken", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/sessionData", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/klarnaAuthorizationToken", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/sessionData", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/recurringDescription", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/billingAddress", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/shippingAddress", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCountry", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCurrency", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/locale", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/orderLines", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/tokenDetails", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaTokenDetails/shape/object/property/type", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaTokenDetails/shape/object/property/brand", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaTokenDetails/shape/object/property/masked_number", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaTokenDetails/shape/object/property/expiry_date", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalBillingAgreementId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/externalPayerInfo", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/shippingAddress", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalStatus", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/externalPayerId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/email", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/firstName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/lastName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalOrderId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/externalPayerInfo", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalStatus", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/first6Digits", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/last4Digits", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationMonth", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationYear", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/cardholderName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/network", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/isNetworkTokenized", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/binData", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:StatusReasonApiSchema/shape/object/property/type", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:StatusReasonApiSchema/shape/object/property/declineType", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:StatusReasonApiSchema/shape/object/property/code", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:StatusReasonApiSchema/shape/object/property/message", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/RELOADABLE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NON_RELOADABLE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NOT_APPLICABLE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/UNKNOWN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/NOT_PERFORMED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/SKIPPED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_SUCCESS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_FAILED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/CHALLENGE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/METHOD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/1", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/responseCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonText", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/protocolVersion", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/challengeIssued", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REJECTED_BY_ISSUER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARD_AUTHENTICATION_FAILED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN_DEVICE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNSUPPORTED_DEVICE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXPIRED_CARD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_CARD_NUMBER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_TRANSACTION", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NO_CARD_RECORD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SECURITY_FAILURE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/STOLEN_CARD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SUSPECTED_FRAUD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARDHOLDER_NOT_ENROLLED_IN_SERVICE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_TIMED_OUT_AT_THE_ACS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/LOW_CONFIDENCE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/MEDIUM_CONFIDENCE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/HIGH_CONFIDENCE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/VERY_HIGH_CONFIDENCE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_ACS_MAXIMUM_CHALLENGES", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NON_PAYMENT_NOT_SUPPORTED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/THREE_RI_NOT_SUPPORTED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TECHNICAL_ISSUE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_REQUIRED_BY_ACS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_MAX_EXPIRY_EXCEEDED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TIMED_OUT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_ACS_RESPONSE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_SYSTEM_ERROR_RESPONSE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ERROR_GENERATING_CAVV", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/PROTOCOL_VERSION_NOT_SUPPORTED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REQUESTED_PROGRAM_NOT_SUPPORTED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/GATEWAY_UNAVAILABLE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/DISABLED_BY_MERCHANT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/NOT_SUPPORTED_BY_ISSUER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/FAILED_TO_NEGOTIATE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/UNKNOWN_ACS_RESPONSE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/3DS_SERVER_ERROR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_CONFIGURED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_PARTICIPATING", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:DeclineTypeEnum/shape/enum/value/SOFT_DECLINE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:DeclineTypeEnum/shape/enum/value/HARD_DECLINE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ERROR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INVALID_CARD_NUMBER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/EXPIRED_CARD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/LOST_OR_STOLEN_CARD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/SUSPECTED_FRAUD", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/UNKNOWN", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DECLINED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/REFER_TO_CARD_ISSUER", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DO_NOT_HONOR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INSUFFICIENT_FUNDS", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/AUTHENTICATION_REQUIRED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/date", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/amount", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/currencyCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/transactionType", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorTransactionId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorMerchantId", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatus", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatusReason", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/PENDING", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/FAILED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/AUTHORIZED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/SETTLING", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/SETTLED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/DECLINED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape/enum/value/CANCELLED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/APPLICATION_ERROR", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/GATEWAY_REJECTED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/ISSUER_DECLINED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionTypeEnum/shape/enum/value/SALE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionTypeEnum/shape/enum/value/REFUND", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/firstName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/lastName", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/addressLine1", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/addressLine2", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/city", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/state", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/countryCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object/property/postalCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/FIRST_PAYMENT", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/ECOMMERCE", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/SUBSCRIPTION", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/UNSCHEDULED", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardNetworkEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentMethodTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringPaymentTypeSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadNotificationConfig/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadNotificationConfig/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:GoCardlessMandateApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:IdealPayNlTokenApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaTokenDetails/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalOrderTokenApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:StatusReasonApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape/object", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardAccountNumberTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardNetworkEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardProductTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardRegionRestrictionEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentMethodTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PrepaidReloadableEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:DeclineTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatusTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringTransactionTypeEnum/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringPaymentTypeSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/example/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/example/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/example/0", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event/request", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event/request", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/request", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadNotificationConfig/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadNotificationConfig/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AccountFundingTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ApayaCustomerTokenApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardAccountNumberTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardProductTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CardRegionRestrictionEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:CountryCodeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:Currency", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponseProcessorApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:GoCardlessMandateApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:IdealPayNlTokenApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaCustomerTokenApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaPaymentSessionApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaTokenDetails/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalBillingAgreementApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalOrderTokenApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:StatusReasonApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PrepaidReloadableEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthResponseCodeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureFailedReasonCodeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:DeclineTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionDeclineReasonV2Enum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatus", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentStatusTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema/shape", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:RecurringTransactionTypeEnum", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadNotificationConfig", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentStatusWebhookPayloadPayment", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadNotificationConfig", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_paymentWebhooks:PaymentRefundWebhookPayloadPayment", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ApayaCustomerTokenApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:BinDataApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentResponseProcessorApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:GoCardlessMandateApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:IdealPayNlTokenApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaAddressApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaCustomerTokenApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaPaymentSessionApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaSessionDetailsApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:KlarnaTokenDetails", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalBillingAgreementApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalExternalPayerInfoApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PayPalOrderTokenApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:PaymentCardTokenApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:StatusReasonApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:ThreeDSecureAuthenticationApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:TransactionOverviewApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/type-definition/type_:AddressApiSchema", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_status_webhook_event", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_paymentWebhooks.payment_refund_webhook_event", + "3e1141df-b4bc-4dab-9542-53cf91851645/endpoint/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-7ed504c0-fc2e-4a52-b3fd-b277869eda14.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-7ed504c0-fc2e-4a52-b3fd-b277869eda14.json new file mode 100644 index 0000000000..4782fb9c36 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-7ed504c0-fc2e-4a52-b3fd-b277869eda14.json @@ -0,0 +1,1252 @@ +[ + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/query/clientToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/2/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/order", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customer", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/paymentMethod", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/clientToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/customer", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/order", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object/property/paymentMethod", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/2/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/status", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/payment_method_type", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/processor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/currency_code", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/from_date", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/to_date", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/order_id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/min_amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/max_amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/customer_id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/merchant_id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/customer_email_address", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/last_4_digits", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/paypal_email", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/klarna_email", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/limit", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/query/cursor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/requestHeader/X-Idempotency-Key", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/order", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethodToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customer", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethod", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/example/2/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/path/id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/requestHeader/X-Idempotency-Key", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/final", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/example/2/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/path/id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/requestHeader/X-Idempotency-Key", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/request/object/property/reason", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/path/id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/requestHeader/X-Idempotency-Key", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/reason", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/example/2/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/path/id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/request/object/property/resumeToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/path/id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/path/paymentMethodToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/2/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/query/customer_id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/path/paymentMethodToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/path/paymentMethodToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1/snippet/curl/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CREDIT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEBIT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/PREPAID", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CHARGE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEFERRED_DEBIT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/UNKNOWN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mx", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mnc", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mcc", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataOptionalApiSchema/shape/object/property/network", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/network", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCountryCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/issuerName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCurrencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/regionalRestriction", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/accountNumberType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/accountFundingType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/prepaidReloadableIndicator", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/productUsageType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/productCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object/property/productName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/3DS_AUTHENTICATION", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/USE_PRIMER_SDK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/PRIMARY_ACCOUNT_NUMBER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/NETWORK_TOKEN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/UNKNOWN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/AMEX", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/DANKORT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/DINERS_CLUB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/DISCOVER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/ENROUTE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/ELO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/HIPER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/INTERAC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/JCB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/MAESTRO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/MASTERCARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/MIR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/PRIVATE_LABEL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/UNIONPAY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/VISA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape/enum/value/OTHER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardProductTypeEnum/shape/enum/value/CONSUMER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardProductTypeEnum/shape/enum/value/BUSINESS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardProductTypeEnum/shape/enum/value/GOVERNMENT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardProductTypeEnum/shape/enum/value/UNKNOWN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/DOMESTIC_USE_ONLY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/NONE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/UNKNOWN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderDetailsApiSchema/shape/object/property/lineItems", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderDetailsApiSchema/shape/object/property/countryCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderDetailsApiSchema/shape/object/property/fees", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderDetailsApiSchema/shape/object/property/shipping", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderFeesApiSchema/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderFeesApiSchema/shape/object/property/type", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderFeesApiSchema/shape/object/property/description", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/itemId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/description", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/quantity", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/discountAmount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxAmount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/productType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderShippingApiSchema/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/PAYMENT_CARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/options", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object/property/surcharge", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object/property/networks", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/AMEX", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DANKORT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DINERS_CLUB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DISCOVER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ENROUTE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ELO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/HIPER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/INTERAC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/JCB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MAESTRO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MASTERCARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MIR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/PRIVATE_LABEL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/UNIONPAY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/VISA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/OTHER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object/property/surcharge", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/3", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/4", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/5", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/6", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/7", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/isVaulted", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/analyticsId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodData", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/threeDSecureAuthentication", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/emailAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/mobileNumber", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/firstName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/lastName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/billingAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/shippingAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/taxId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/emailAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/mobileNumber", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/firstName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/lastName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/billingAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/shippingAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/taxId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/clientToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/clientTokenExpirationDate", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/order", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/customer", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/paymentMethod", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object/property/warnings", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/customer", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/order", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object/property/paymentMethod", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/type", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/code", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/message", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AX", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AQ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/AZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BJ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BQ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/BW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CX", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/CZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/DE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/DJ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/DM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/DK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/DO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/DZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/EC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/EG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/EH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ES", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/EE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ET", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/FI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/FJ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/FK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/FR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/FO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/FM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GQ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/HK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/HM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/HN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/HR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/HT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/HU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ID", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IQ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/IT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/JM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/JE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/JO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/JP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/LV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MX", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ML", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ME", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MQ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/MY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/YT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/NZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/OM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/KP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/QA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/RE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/RO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/RU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/RW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/GS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SJ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/PM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/RS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ST", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SX", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/SY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TJ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/TZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/UG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/UA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/UM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/UY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/US", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/UZ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/VA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/VC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/VE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/VG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/VI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/VN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/VU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/WF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/WS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/YE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ZA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ZM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape/enum/value/ZW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/AED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/AFN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ALL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/AMD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ANG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/AOA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ARS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/AUD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/AWG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/AZN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BAM", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BBD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BDT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BGN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BHD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BIF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BMD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BND", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BOB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BOV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BRL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BSD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BTN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BWP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BYR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BYN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/BZD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CAD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CDF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CHE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CHF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CHW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CLF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CLP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CNY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/COP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/COU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CRC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CUC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CUP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CVE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/CZK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/DJF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/DKK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/DOP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/DZD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/EGP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ERN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ETB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/EUR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/FJD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/FKP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GBP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GEL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GHS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GIP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GMD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GNF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GTQ", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/GYD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/HKD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/HNL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/HRK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/HTG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/HUF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/IDR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ILS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/INR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/IQD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/IRR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ISK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/JMD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/JOD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/JPY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KES", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KGS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KHR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KMF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KPW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KRW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KWD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KYD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/KZT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LAK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LBP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LKR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LRD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LSL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LTL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LVL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/LYD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MAD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MDL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MGA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MKD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MMK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MNT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MOP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MRO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MUR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MVR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MWK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MXN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MXV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MYR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/MZN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/NAD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/NGN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/NIO", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/NOK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/NPR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/NZD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/OMR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/PAB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/PEN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/PGK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/PHP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/PKR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/PLN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/PYG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/QAR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/RON", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/RSD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/RUB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/RWF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SAR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SBD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SCR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SDG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SEK", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SGD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SHP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SLL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SOS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SRD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SSP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/STD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SVC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SYP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/SZL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/THB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TJS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TMT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TND", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TOP", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TRY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TTD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TWD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/TZS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/UAH", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/UGX", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/USD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/USN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/USS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/UYI", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/UYU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/UZS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/VEF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/VND", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/VUV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/WST", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XAF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XAG", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XAU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XBA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XBB", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XBC", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XBD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XCD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XDR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XFU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XOF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XPD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XPF", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XPT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XSU", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XTS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/XUA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/YER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ZAR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ZMW", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape/enum/value/ZWL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/name", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/processorMerchantId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountCaptured", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountRefunded", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:GoCardlessMandateApiSchema/shape/object/property/gocardlessMandateId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:IdealPayNlTokenApiSchema/shape/object/property/paymentMethodConfigId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/title", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/firstName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/lastName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/email", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/phoneNumber", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine3", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/city", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/state", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/countryCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/postalCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/klarnaCustomerToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/sessionData", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/klarnaAuthorizationToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/sessionData", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/recurringDescription", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/billingAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/shippingAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCountry", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCurrency", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/locale", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/orderLines", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/tokenDetails", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaTokenDetails/shape/object/property/type", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaTokenDetails/shape/object/property/brand", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaTokenDetails/shape/object/property/masked_number", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaTokenDetails/shape/object/property/expiry_date", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalBillingAgreementId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/externalPayerInfo", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/shippingAddress", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalStatus", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/externalPayerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/email", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/firstName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/lastName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalOrderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/externalPayerInfo", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalStatus", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/date", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/status", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/order", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/customer", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/paymentMethod", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/processor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/requiredAction", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/statusReason", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object/property/transactions", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/first6Digits", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/last4Digits", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationMonth", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationYear", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/cardholderName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/network", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/isNetworkTokenized", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/binData", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:StatusReasonApiSchema/shape/object/property/type", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:StatusReasonApiSchema/shape/object/property/declineType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:StatusReasonApiSchema/shape/object/property/code", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:StatusReasonApiSchema/shape/object/property/message", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYMENT_CARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYPAL_ORDER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYPAL_BILLING_AGREEMENT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/GOCARDLESS_MANDATE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/KLARNA_AUTHORIZATION_TOKEN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/KLARNA_CUSTOMER_TOKEN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_IDEAL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APAYA", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/OFF_SESSION_PAYMENT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/CARD_OFF_SESSION_PAYMENT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APPLE_PAY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APPLE_PAY_ENCRYPTED_TOKEN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/GOOGLE_PAY", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentListApiResponse/shape/object/property/data", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentListApiResponse/shape/object/property/nextCursor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentListApiResponse/shape/object/property/prevCursor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/name", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/description", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/clientToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/id", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/date", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/status", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/orderId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/processor", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/metadata", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/name", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/processorMerchantId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/RELOADABLE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NON_RELOADABLE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NOT_APPLICABLE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/UNKNOWN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/FIRST_PAYMENT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/ECOMMERCE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/SUBSCRIPTION", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/UNSCHEDULED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ProductTypeEnum/shape/enum/value/PHYSICAL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ProductTypeEnum/shape/enum/value/DIGITAL", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/NOT_PERFORMED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/SKIPPED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_SUCCESS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_FAILED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/CHALLENGE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/METHOD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/responseCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonText", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/protocolVersion", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/challengeIssued", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REJECTED_BY_ISSUER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARD_AUTHENTICATION_FAILED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN_DEVICE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNSUPPORTED_DEVICE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXPIRED_CARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_CARD_NUMBER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_TRANSACTION", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NO_CARD_RECORD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SECURITY_FAILURE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/STOLEN_CARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SUSPECTED_FRAUD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARDHOLDER_NOT_ENROLLED_IN_SERVICE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_TIMED_OUT_AT_THE_ACS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/LOW_CONFIDENCE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/MEDIUM_CONFIDENCE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/HIGH_CONFIDENCE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/VERY_HIGH_CONFIDENCE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_ACS_MAXIMUM_CHALLENGES", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NON_PAYMENT_NOT_SUPPORTED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/THREE_RI_NOT_SUPPORTED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TECHNICAL_ISSUE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_REQUIRED_BY_ACS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_MAX_EXPIRY_EXCEEDED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TIMED_OUT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_ACS_RESPONSE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_SYSTEM_ERROR_RESPONSE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ERROR_GENERATING_CAVV", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/PROTOCOL_VERSION_NOT_SUPPORTED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REQUESTED_PROGRAM_NOT_SUPPORTED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/GATEWAY_UNAVAILABLE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/DISABLED_BY_MERCHANT", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/NOT_SUPPORTED_BY_ISSUER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/FAILED_TO_NEGOTIATE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/UNKNOWN_ACS_RESPONSE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/3DS_SERVER_ERROR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_CONFIGURED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_PARTICIPATING", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TokenTypeEnum/shape/enum/value/MULTI_USE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TokenTypeEnum/shape/enum/value/SINGLE_USE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:DeclineTypeEnum/shape/enum/value/SOFT_DECLINE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:DeclineTypeEnum/shape/enum/value/HARD_DECLINE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ERROR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INVALID_CARD_NUMBER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/EXPIRED_CARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/LOST_OR_STOLEN_CARD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/SUSPECTED_FRAUD", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/UNKNOWN", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DECLINED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/REFER_TO_CARD_ISSUER", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DO_NOT_HONOR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INSUFFICIENT_FUNDS", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/AUTHENTICATION_REQUIRED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/date", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/amount", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/currencyCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/transactionType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorTransactionId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorMerchantId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatus", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatusReason", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/PENDING", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/FAILED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/AUTHORIZED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/SETTLING", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/SETTLED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/DECLINED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape/enum/value/CANCELLED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/APPLICATION_ERROR", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/GATEWAY_REJECTED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/ISSUER_DECLINED", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionTypeEnum/shape/enum/value/SALE", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionTypeEnum/shape/enum/value/REFUND", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/firstName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/lastName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/addressLine1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/addressLine2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/city", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/state", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/countryCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/postalCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/firstName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/lastName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/addressLine1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/addressLine2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/city", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/state", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/countryCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object/property/postalCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/3", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/4", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/createdAt", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deletedAt", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deleted", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/token", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/tokenType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/analyticsId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodData", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/customerId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/description", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/default", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape/object/property/isVerified", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenListApiResponse/shape/object/property/data", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape/object/property/data", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/last4Digits", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/expirationMonth", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/expirationYear", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/cardholderName", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/network", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/networkTransactionId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/accountFundingType", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ErrorObject/shape/object/property/errorId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ErrorObject/shape/object/property/description", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ErrorObject/shape/object/property/diagnosticsId", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ErrorObject/shape/object/property/validationErrors", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/1/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/1/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/error/0/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/error/1/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/error/1/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/error/1/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/1/422/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/response", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400/error/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringPaymentTypeSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:four_hundred_ErrorResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataOptionalApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderDetailsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderFeesApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderShippingApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWarningsApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:GoCardlessMandateApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:IdealPayNlTokenApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaTokenDetails/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalOrderTokenApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:StatusReasonApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentListApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequiredActionApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenListApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ErrorObject/shape/object", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BlockingPaymentActionTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardAccountNumberTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardProductTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardRegionRestrictionEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PrepaidReloadableEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringTransactionTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringPaymentTypeSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ProductTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TokenTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:DeclineTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatusTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionTypeEnum/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:four_hundred_ErrorResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:four_hundred_twenty_two_ErrorResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/error/1/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken/example/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/error/1/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/example/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/error/0/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/error/1/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/example/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/error/1/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/example/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/error/1/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/example/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/1/422", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/2", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AccountFundingTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ApayaCustomerTokenApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataOptionalApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BlockingPaymentActionTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardAccountNumberTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardNetworkEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardProductTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CardRegionRestrictionEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderDetailsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderFeesApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderShippingApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWarningsApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CountryCodeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:Currency", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponseProcessorApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:GoCardlessMandateApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:IdealPayNlTokenApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaCustomerTokenApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaPaymentSessionApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaTokenDetails/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalBillingAgreementApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalOrderTokenApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:StatusReasonApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentMethodTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentListApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequiredActionApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryProcessorApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PrepaidReloadableEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:RecurringTransactionTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ProductTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthResponseCodeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureFailedReasonCodeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TokenTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:DeclineTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionDeclineReasonV2Enum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatus", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentStatusTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionTypeEnum", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenListApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ErrorObject/shape", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ApayaCustomerTokenApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataOptionalApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:BinDataApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderDetailsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderFeesApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderLineItemsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:OrderShippingApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CheckoutCustomerDetailsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CustomerDetailsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWithTokenApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ClientSessionWarningsApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentResponseProcessorApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:GoCardlessMandateApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:IdealPayNlTokenApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaAddressApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaCustomerTokenApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaPaymentSessionApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaSessionDetailsApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:KlarnaTokenDetails", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalBillingAgreementApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalExternalPayerInfoApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PayPalOrderTokenApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:StatusReasonApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentListApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentRequiredActionApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentSummaryProcessorApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ThreeDSecureAuthenticationApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:TransactionOverviewApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:AddressApiSchema", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:MerchantPaymentMethodTokenListApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:VerifiedMerchantPaymentMethodTokenListApiResponse", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/type-definition/type_:ErrorObject", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.retrieveClientSideToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.createClientSideToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_clientSessionApi.updateClientSideToken", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.listPayments", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.createPayment", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.capturePayment", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.cancelPayment", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.refundPayment", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.resumePayment", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentsApi.getPaymentById", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "7ed504c0-fc2e-4a52-b3fd-b277869eda14/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-c5629660-3984-4ce0-989e-9c6fb0df36d9.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-c5629660-3984-4ce0-989e-9c6fb0df36d9.json new file mode 100644 index 0000000000..bb3e6a010b --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-c5629660-3984-4ce0-989e-9c6fb0df36d9.json @@ -0,0 +1,945 @@ +[ + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/header/X-Signature-Primary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/header/X-Signature-Secondary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/header/X-Signature-Primary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/header/X-Signature-Secondary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/header/X-Signature-Primary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/header/X-Signature-Secondary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/header/X-Signature-Primary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/header/X-Signature-Secondary", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CREDIT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEBIT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/PREPAID", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CHARGE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEFERRED_DEBIT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/UNKNOWN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mx", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mnc", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mcc", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/network", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCountryCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/issuerName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCurrencyCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/regionalRestriction", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/accountNumberType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/accountFundingType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/prepaidReloadableIndicator", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/productUsageType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/productCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object/property/productName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/PRIMARY_ACCOUNT_NUMBER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/NETWORK_TOKEN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/UNKNOWN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardProductTypeEnum/shape/enum/value/CONSUMER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardProductTypeEnum/shape/enum/value/BUSINESS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardProductTypeEnum/shape/enum/value/GOVERNMENT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardProductTypeEnum/shape/enum/value/UNKNOWN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/DOMESTIC_USE_ONLY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/NONE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/UNKNOWN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/0", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/1", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/2", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/3", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/4", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/5", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/6", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/7", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodToken", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/vaultedPaymentMethodToken", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/analyticsId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/threeDSecureAuthentication", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AX", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AQ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/AZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BJ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BQ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/BW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CX", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/CZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/DE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/DJ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/DM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/DK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/DO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/DZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/EC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/EG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/EH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ES", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/EE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ET", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/FI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/FJ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/FK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/FR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/FO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/FM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GQ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/HK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/HM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/HN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/HR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/HT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/HU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ID", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IQ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/IT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/JM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/JE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/JO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/JP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/LV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MX", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ML", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ME", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MQ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/MY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/YT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/NZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/OM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/KP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/QA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/RE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/RO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/RU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/RW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/GS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SJ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/PM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/RS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ST", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SX", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/SY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TJ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/TZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/UG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/UA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/UM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/UY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/US", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/UZ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/VA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/VC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/VE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/VG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/VI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/VN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/VU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/WF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/WS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/YE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ZA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ZM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape/enum/value/ZW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/AED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/AFN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ALL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/AMD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ANG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/AOA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ARS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/AUD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/AWG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/AZN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BAM", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BBD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BDT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BGN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BHD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BIF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BMD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BND", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BOB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BOV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BRL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BSD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BTN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BWP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BYR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BYN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/BZD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CAD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CDF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CHE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CHF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CHW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CLF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CLP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CNY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/COP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/COU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CRC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CUC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CUP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CVE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/CZK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/DJF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/DKK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/DOP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/DZD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/EGP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ERN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ETB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/EUR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/FJD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/FKP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GBP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GEL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GHS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GIP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GMD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GNF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GTQ", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/GYD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/HKD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/HNL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/HRK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/HTG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/HUF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/IDR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ILS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/INR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/IQD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/IRR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ISK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/JMD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/JOD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/JPY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KES", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KGS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KHR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KMF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KPW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KRW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KWD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KYD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/KZT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LAK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LBP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LKR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LRD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LSL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LTL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LVL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/LYD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MAD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MDL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MGA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MKD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MMK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MNT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MOP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MRO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MUR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MVR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MWK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MXN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MXV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MYR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/MZN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/NAD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/NGN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/NIO", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/NOK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/NPR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/NZD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/OMR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/PAB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/PEN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/PGK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/PHP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/PKR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/PLN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/PYG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/QAR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/RON", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/RSD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/RUB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/RWF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SAR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SBD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SCR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SDG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SEK", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SGD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SHP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SLL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SOS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SRD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SSP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/STD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SVC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SYP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/SZL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/THB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TJS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TMT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TND", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TOP", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TRY", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TTD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TWD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/TZS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/UAH", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/UGX", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/USD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/USN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/USS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/UYI", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/UYU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/UZS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/VEF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/VND", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/VUV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/WST", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XAF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XAG", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XAU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XBA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XBB", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XBC", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XBD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XCD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XDR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XFU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XOF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XPD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XPF", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XPT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XSU", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XTS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/XUA", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/YER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ZAR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ZMW", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape/enum/value/ZWL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/name", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/processorMerchantId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountCaptured", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountRefunded", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:GoCardlessMandateApiSchema/shape/object/property/gocardlessMandateId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:IdealPayNlTokenApiSchema/shape/object/property/paymentMethodConfigId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/title", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/firstName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/lastName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/email", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/phoneNumber", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine1", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine2", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine3", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/city", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/state", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/countryCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/postalCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/klarnaCustomerToken", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/sessionData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/klarnaAuthorizationToken", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/sessionData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/recurringDescription", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/billingAddress", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/shippingAddress", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCountry", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCurrency", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/locale", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/orderLines", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/tokenDetails", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaTokenDetails/shape/object/property/type", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaTokenDetails/shape/object/property/brand", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaTokenDetails/shape/object/property/masked_number", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaTokenDetails/shape/object/property/expiry_date", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalBillingAgreementId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/externalPayerInfo", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/shippingAddress", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalStatus", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/externalPayerId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/email", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/firstName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/lastName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalOrderId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/externalPayerInfo", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalStatus", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape/object/property/id", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape/object/property/description", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/id", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/date", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/status", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/orderId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/currencyCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/amount", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/customerId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/metadata", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/paymentMethod", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/processor", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/statusReason", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/transactions", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/riskData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/eventType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/date", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/notificationConfig", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/version", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/payment", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape/object/property/id", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape/object/property/description", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/id", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/date", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/status", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/orderId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/currencyCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/amount", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/customerId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/metadata", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/paymentMethod", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/processor", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/statusReason", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/transactions", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/riskData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/eventType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/date", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/notificationConfig", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/version", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/payment", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/eventType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/processorId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/processorDisputeId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/paymentId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/transactionId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/orderId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/primerAccountId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadType/shape/enum/value/RETRIEVAL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadType/shape/enum/value/DISPUTE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadType/shape/enum/value/PREARBITRATION", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/OPEN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/ACCEPTED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/CHALLENGED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/EXPIRED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/CANCELLED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/WON", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/LOST", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData/shape/object/property/network", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape/object/property/paymentMethodType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape/object/property/paymentMethodData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadProcessor/shape/enum/value/ADYEN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadProcessor/shape/enum/value/BRAINTREE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/eventType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/version", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/type", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/status", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/primerAccountId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/transactionId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/orderId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/paymentId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/paymentMethod", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/processor", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/processorDisputeId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/receivedAt", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/challengeRequiredBy", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/reason", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/reasonCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/processorReason", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/amount", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/currency", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/merchantId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/first6Digits", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/last4Digits", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationMonth", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationYear", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/cardholderName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/network", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/isNetworkTokenized", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/binData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:StatusReasonApiSchema/shape/object/property/type", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:StatusReasonApiSchema/shape/object/property/declineType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:StatusReasonApiSchema/shape/object/property/code", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:StatusReasonApiSchema/shape/object/property/message", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskDataApiSchema/shape/object/property/fraudChecks", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskDataApiSchema/shape/object/property/cvvCheck", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskDataApiSchema/shape/object/property/avsCheck", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudCheckApiSchema/shape/object/property/source", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudCheckApiSchema/shape/object/property/preAuthorizationResult", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudCheckApiSchema/shape/object/property/postAuthorizationResult", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/ACCEPT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/REFUSE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/FAILED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/THREE_DS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CvvCheckApiSchema/shape/object/property/source", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CvvCheckApiSchema/shape/object/property/result", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsCheckApiSchema/shape/object/property/source", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsCheckApiSchema/shape/object/property/result", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/streetAddress", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/postalCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/MATCHED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_MATCHED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_VERIFIED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_PROVIDED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_APPLICABLE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/SKIPPED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/RELOADABLE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NON_RELOADABLE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NOT_APPLICABLE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/UNKNOWN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/NOT_PERFORMED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/SKIPPED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_SUCCESS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_FAILED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/CHALLENGE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/METHOD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/0", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/1", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/responseCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonText", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/protocolVersion", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/challengeIssued", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REJECTED_BY_ISSUER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARD_AUTHENTICATION_FAILED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN_DEVICE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNSUPPORTED_DEVICE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXPIRED_CARD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_CARD_NUMBER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_TRANSACTION", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NO_CARD_RECORD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SECURITY_FAILURE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/STOLEN_CARD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SUSPECTED_FRAUD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARDHOLDER_NOT_ENROLLED_IN_SERVICE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_TIMED_OUT_AT_THE_ACS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/LOW_CONFIDENCE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/MEDIUM_CONFIDENCE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/HIGH_CONFIDENCE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/VERY_HIGH_CONFIDENCE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_ACS_MAXIMUM_CHALLENGES", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NON_PAYMENT_NOT_SUPPORTED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/THREE_RI_NOT_SUPPORTED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TECHNICAL_ISSUE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_REQUIRED_BY_ACS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_MAX_EXPIRY_EXCEEDED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TIMED_OUT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_ACS_RESPONSE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_SYSTEM_ERROR_RESPONSE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ERROR_GENERATING_CAVV", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/PROTOCOL_VERSION_NOT_SUPPORTED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REQUESTED_PROGRAM_NOT_SUPPORTED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/GATEWAY_UNAVAILABLE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/DISABLED_BY_MERCHANT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/NOT_SUPPORTED_BY_ISSUER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/FAILED_TO_NEGOTIATE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/UNKNOWN_ACS_RESPONSE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/3DS_SERVER_ERROR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_CONFIGURED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_PARTICIPATING", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DeclineTypeEnum/shape/enum/value/SOFT_DECLINE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DeclineTypeEnum/shape/enum/value/HARD_DECLINE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ERROR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INVALID_CARD_NUMBER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/EXPIRED_CARD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/LOST_OR_STOLEN_CARD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/SUSPECTED_FRAUD", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/UNKNOWN", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DECLINED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/REFER_TO_CARD_ISSUER", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DO_NOT_HONOR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INSUFFICIENT_FUNDS", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/AUTHENTICATION_REQUIRED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/transactionType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorTransactionId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorMerchantId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatus", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatusReason", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/PENDING", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/FAILED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/AUTHORIZED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/SETTLING", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/SETTLED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/DECLINED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape/enum/value/CANCELLED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/APPLICATION_ERROR", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/GATEWAY_REJECTED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/ISSUER_DECLINED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionTypeEnum/shape/enum/value/SALE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionTypeEnum/shape/enum/value/REFUND", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/firstName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/lastName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/addressLine1", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/addressLine2", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/city", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/state", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/countryCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object/property/postalCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/FIRST_PAYMENT", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/ECOMMERCE", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/SUBSCRIPTION", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/UNSCHEDULED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/ESTIMATED", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/FINAL", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/firstName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/lastName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine1", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine2", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/city", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/state", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/countryCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object/property/postalCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/emailAddress", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/mobileNumber", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/firstName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/lastName", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/billingAddress", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/shippingAddress", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/taxId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/payload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/payload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/payload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/payload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardNetworkEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentMethodTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringPaymentTypeSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:GoCardlessMandateApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:IdealPayNlTokenApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaTokenDetails/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalOrderTokenApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:StatusReasonApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskDataApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudCheckApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CvvCheckApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsCheckApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsRiskAssessmentValues/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/payload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/payload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/payload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/payload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardAccountNumberTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardNetworkEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardProductTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardRegionRestrictionEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadType/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadProcessor/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudDecisionTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentMethodTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PrepaidReloadableEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DeclineTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringTransactionTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringPaymentTypeSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AuthorizationTypeEnum/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AccountFundingTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ApayaCustomerTokenApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardAccountNumberTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardProductTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CardRegionRestrictionEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CountryCodeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:Currency", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponseProcessorApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:GoCardlessMandateApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:IdealPayNlTokenApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaCustomerTokenApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaPaymentSessionApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaTokenDetails/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalBillingAgreementApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalOrderTokenApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadType", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadStatus", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadProcessor", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:StatusReasonApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskDataApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudCheckApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudDecisionTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CvvCheckApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsCheckApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsRiskAssessmentValues/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskAssessmentStatusEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PrepaidReloadableEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthResponseCodeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureFailedReasonCodeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DeclineTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionDeclineReasonV2Enum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatus", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RecurringTransactionTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AuthorizationTypeEnum", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ApayaCustomerTokenApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:BinDataApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentResponseProcessorApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:GoCardlessMandateApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:IdealPayNlTokenApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaAddressApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaCustomerTokenApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaPaymentSessionApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaSessionDetailsApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:KlarnaTokenDetails", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalBillingAgreementApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalExternalPayerInfoApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PayPalOrderTokenApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayloadPayment", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentStatusWebhookPayload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayloadPayment", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentRefundWebhookPayload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeOpenWebhookPayload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:DisputeStatusWebhookPayload", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:PaymentCardTokenApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:StatusReasonApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:RiskDataApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:FraudCheckApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CvvCheckApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsCheckApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AvsRiskAssessmentValues", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:ThreeDSecureAuthenticationApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:TransactionOverviewApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:AddressApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:OptionalAddressApiSchema", + "c5629660-3984-4ce0-989e-9c6fb0df36d9/type-definition/type_:CheckoutCustomerDetailsApiSchema" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-ca56f687-5be3-4661-aeed-674a0f1f7193.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-ca56f687-5be3-4661-aeed-674a0f1f7193.json new file mode 100644 index 0000000000..a369fabb3c --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-ca56f687-5be3-4661-aeed-674a0f1f7193.json @@ -0,0 +1,945 @@ +[ + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/header/X-Signature-Primary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/header/X-Signature-Secondary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/header/X-Signature-Primary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/header/X-Signature-Secondary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/header/X-Signature-Primary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/header/X-Signature-Secondary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/header/X-Signature-Primary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/header/X-Signature-Secondary", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CREDIT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEBIT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/PREPAID", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CHARGE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEFERRED_DEBIT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/UNKNOWN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mx", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mnc", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mcc", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/network", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCountryCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/issuerName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCurrencyCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/regionalRestriction", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/accountNumberType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/accountFundingType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/prepaidReloadableIndicator", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/productUsageType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/productCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object/property/productName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/PRIMARY_ACCOUNT_NUMBER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/NETWORK_TOKEN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/UNKNOWN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardProductTypeEnum/shape/enum/value/CONSUMER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardProductTypeEnum/shape/enum/value/BUSINESS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardProductTypeEnum/shape/enum/value/GOVERNMENT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardProductTypeEnum/shape/enum/value/UNKNOWN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/DOMESTIC_USE_ONLY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/NONE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/UNKNOWN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/0", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/1", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/2", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/3", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/4", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/5", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/6", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/7", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodToken", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/vaultedPaymentMethodToken", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/analyticsId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/threeDSecureAuthentication", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AX", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AQ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/AZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BJ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BQ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/BW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CX", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/CZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/DE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/DJ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/DM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/DK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/DO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/DZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/EC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/EG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/EH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ES", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/EE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ET", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/FI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/FJ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/FK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/FR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/FO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/FM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GQ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/HK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/HM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/HN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/HR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/HT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/HU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ID", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IQ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/IT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/JM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/JE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/JO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/JP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/LV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MX", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ML", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ME", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MQ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/MY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/YT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/NZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/OM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/KP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/QA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/RE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/RO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/RU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/RW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/GS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SJ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/PM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/RS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ST", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SX", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/SY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TJ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/TZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/UG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/UA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/UM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/UY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/US", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/UZ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/VA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/VC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/VE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/VG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/VI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/VN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/VU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/WF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/WS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/YE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ZA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ZM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape/enum/value/ZW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/AED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/AFN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ALL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/AMD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ANG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/AOA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ARS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/AUD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/AWG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/AZN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BAM", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BBD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BDT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BGN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BHD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BIF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BMD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BND", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BOB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BOV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BRL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BSD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BTN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BWP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BYR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BYN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/BZD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CAD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CDF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CHE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CHF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CHW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CLF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CLP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CNY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/COP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/COU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CRC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CUC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CUP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CVE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/CZK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/DJF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/DKK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/DOP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/DZD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/EGP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ERN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ETB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/EUR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/FJD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/FKP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GBP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GEL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GHS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GIP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GMD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GNF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GTQ", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/GYD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/HKD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/HNL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/HRK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/HTG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/HUF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/IDR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ILS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/INR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/IQD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/IRR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ISK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/JMD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/JOD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/JPY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KES", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KGS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KHR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KMF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KPW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KRW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KWD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KYD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/KZT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LAK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LBP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LKR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LRD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LSL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LTL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LVL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/LYD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MAD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MDL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MGA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MKD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MMK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MNT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MOP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MRO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MUR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MVR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MWK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MXN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MXV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MYR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/MZN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/NAD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/NGN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/NIO", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/NOK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/NPR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/NZD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/OMR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/PAB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/PEN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/PGK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/PHP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/PKR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/PLN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/PYG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/QAR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/RON", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/RSD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/RUB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/RWF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SAR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SBD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SCR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SDG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SEK", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SGD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SHP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SLL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SOS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SRD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SSP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/STD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SVC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SYP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/SZL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/THB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TJS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TMT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TND", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TOP", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TRY", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TTD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TWD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/TZS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/UAH", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/UGX", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/USD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/USN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/USS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/UYI", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/UYU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/UZS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/VEF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/VND", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/VUV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/WST", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XAF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XAG", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XAU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XBA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XBB", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XBC", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XBD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XCD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XDR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XFU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XOF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XPD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XPF", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XPT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XSU", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XTS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/XUA", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/YER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ZAR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ZMW", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape/enum/value/ZWL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/name", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/processorMerchantId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountCaptured", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountRefunded", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:GoCardlessMandateApiSchema/shape/object/property/gocardlessMandateId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:IdealPayNlTokenApiSchema/shape/object/property/paymentMethodConfigId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/title", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/firstName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/lastName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/email", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/phoneNumber", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine1", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine2", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine3", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/city", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/state", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/countryCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/postalCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/klarnaCustomerToken", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/sessionData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/klarnaAuthorizationToken", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/sessionData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/recurringDescription", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/billingAddress", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/shippingAddress", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCountry", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCurrency", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/locale", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/orderLines", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/tokenDetails", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaTokenDetails/shape/object/property/type", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaTokenDetails/shape/object/property/brand", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaTokenDetails/shape/object/property/masked_number", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaTokenDetails/shape/object/property/expiry_date", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalBillingAgreementId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/externalPayerInfo", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/shippingAddress", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalStatus", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/externalPayerId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/email", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/firstName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/lastName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalOrderId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/externalPayerInfo", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalStatus", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape/object/property/id", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape/object/property/description", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/id", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/date", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/status", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/orderId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/currencyCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/amount", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/customerId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/metadata", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/paymentMethod", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/processor", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/statusReason", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/transactions", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object/property/riskData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/eventType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/date", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/notificationConfig", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/version", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload/shape/object/property/payment", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape/object/property/id", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape/object/property/description", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/id", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/date", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/status", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/orderId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/currencyCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/amount", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/customerId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/metadata", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/paymentMethod", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/processor", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/statusReason", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/transactions", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object/property/riskData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/eventType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/date", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/notificationConfig", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/version", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload/shape/object/property/payment", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/eventType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/processorId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/processorDisputeId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/paymentId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/transactionId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/orderId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object/property/primerAccountId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadType/shape/enum/value/RETRIEVAL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadType/shape/enum/value/DISPUTE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadType/shape/enum/value/PREARBITRATION", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/OPEN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/ACCEPTED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/CHALLENGED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/EXPIRED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/CANCELLED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/WON", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape/enum/value/LOST", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData/shape/object/property/network", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape/object/property/paymentMethodType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape/object/property/paymentMethodData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadProcessor/shape/enum/value/ADYEN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadProcessor/shape/enum/value/BRAINTREE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/eventType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/version", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/type", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/status", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/primerAccountId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/transactionId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/orderId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/paymentId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/paymentMethod", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/processor", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/processorDisputeId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/receivedAt", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/challengeRequiredBy", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/reason", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/reasonCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/processorReason", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/amount", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/currency", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object/property/merchantId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/first6Digits", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/last4Digits", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationMonth", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationYear", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/cardholderName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/network", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/isNetworkTokenized", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/binData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:StatusReasonApiSchema/shape/object/property/type", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:StatusReasonApiSchema/shape/object/property/declineType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:StatusReasonApiSchema/shape/object/property/code", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:StatusReasonApiSchema/shape/object/property/message", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskDataApiSchema/shape/object/property/fraudChecks", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskDataApiSchema/shape/object/property/cvvCheck", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskDataApiSchema/shape/object/property/avsCheck", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudCheckApiSchema/shape/object/property/source", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudCheckApiSchema/shape/object/property/preAuthorizationResult", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudCheckApiSchema/shape/object/property/postAuthorizationResult", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/ACCEPT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/REFUSE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/FAILED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudDecisionTypeEnum/shape/enum/value/THREE_DS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CvvCheckApiSchema/shape/object/property/source", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CvvCheckApiSchema/shape/object/property/result", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsCheckApiSchema/shape/object/property/source", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsCheckApiSchema/shape/object/property/result", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/streetAddress", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsRiskAssessmentValues/shape/object/property/postalCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/MATCHED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_MATCHED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_VERIFIED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_PROVIDED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/NOT_APPLICABLE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum/shape/enum/value/SKIPPED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/RELOADABLE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NON_RELOADABLE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NOT_APPLICABLE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/UNKNOWN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/NOT_PERFORMED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/SKIPPED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_SUCCESS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_FAILED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/CHALLENGE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/METHOD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/0", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/1", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/responseCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonText", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/protocolVersion", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/challengeIssued", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REJECTED_BY_ISSUER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARD_AUTHENTICATION_FAILED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN_DEVICE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNSUPPORTED_DEVICE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXPIRED_CARD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_CARD_NUMBER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_TRANSACTION", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NO_CARD_RECORD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SECURITY_FAILURE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/STOLEN_CARD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SUSPECTED_FRAUD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARDHOLDER_NOT_ENROLLED_IN_SERVICE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_TIMED_OUT_AT_THE_ACS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/LOW_CONFIDENCE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/MEDIUM_CONFIDENCE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/HIGH_CONFIDENCE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/VERY_HIGH_CONFIDENCE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_ACS_MAXIMUM_CHALLENGES", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NON_PAYMENT_NOT_SUPPORTED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/THREE_RI_NOT_SUPPORTED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TECHNICAL_ISSUE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_REQUIRED_BY_ACS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_MAX_EXPIRY_EXCEEDED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TIMED_OUT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_ACS_RESPONSE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_SYSTEM_ERROR_RESPONSE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ERROR_GENERATING_CAVV", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/PROTOCOL_VERSION_NOT_SUPPORTED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REQUESTED_PROGRAM_NOT_SUPPORTED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/GATEWAY_UNAVAILABLE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/DISABLED_BY_MERCHANT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/NOT_SUPPORTED_BY_ISSUER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/FAILED_TO_NEGOTIATE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/UNKNOWN_ACS_RESPONSE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/3DS_SERVER_ERROR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_CONFIGURED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_PARTICIPATING", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DeclineTypeEnum/shape/enum/value/SOFT_DECLINE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DeclineTypeEnum/shape/enum/value/HARD_DECLINE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ERROR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INVALID_CARD_NUMBER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/EXPIRED_CARD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/LOST_OR_STOLEN_CARD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/SUSPECTED_FRAUD", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/UNKNOWN", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DECLINED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/REFER_TO_CARD_ISSUER", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DO_NOT_HONOR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INSUFFICIENT_FUNDS", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/AUTHENTICATION_REQUIRED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/transactionType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorTransactionId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorMerchantId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatus", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatusReason", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/PENDING", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/FAILED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/AUTHORIZED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/SETTLING", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/SETTLED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/DECLINED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape/enum/value/CANCELLED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/APPLICATION_ERROR", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/GATEWAY_REJECTED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/ISSUER_DECLINED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionTypeEnum/shape/enum/value/SALE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionTypeEnum/shape/enum/value/REFUND", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/firstName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/lastName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/addressLine1", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/addressLine2", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/city", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/state", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/countryCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object/property/postalCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/FIRST_PAYMENT", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/ECOMMERCE", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/SUBSCRIPTION", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/UNSCHEDULED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/ESTIMATED", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AuthorizationTypeEnum/shape/enum/value/FINAL", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/firstName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/lastName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine1", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/addressLine2", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/city", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/state", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/countryCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object/property/postalCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/emailAddress", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/mobileNumber", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/firstName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/lastName", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/billingAddress", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/shippingAddress", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/taxId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/payload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/payload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/payload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/payload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardNetworkEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentMethodTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringPaymentTypeSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:GoCardlessMandateApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:IdealPayNlTokenApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaTokenDetails/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalOrderTokenApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:StatusReasonApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskDataApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudCheckApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CvvCheckApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsCheckApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsRiskAssessmentValues/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event/payload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event/payload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event/payload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event/payload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardAccountNumberTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardNetworkEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardProductTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardRegionRestrictionEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadType/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadProcessor/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudDecisionTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentMethodTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PrepaidReloadableEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DeclineTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringTransactionTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringPaymentTypeSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AuthorizationTypeEnum/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AccountFundingTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ApayaCustomerTokenApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardAccountNumberTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardProductTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CardRegionRestrictionEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CountryCodeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:Currency", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponseProcessorApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:GoCardlessMandateApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:IdealPayNlTokenApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaCustomerTokenApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaPaymentSessionApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaTokenDetails/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalBillingAgreementApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalOrderTokenApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadType", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadStatus", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadProcessor", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:StatusReasonApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskDataApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudCheckApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudDecisionTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CvvCheckApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsCheckApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsRiskAssessmentValues/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskAssessmentStatusEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PrepaidReloadableEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthResponseCodeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureFailedReasonCodeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DeclineTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionDeclineReasonV2Enum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatus", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RecurringTransactionTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AuthorizationTypeEnum", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_status_webhook_event", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_paymentWebhooks.payment_refund_webhook_event", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event", + "ca56f687-5be3-4661-aeed-674a0f1f7193/webhoook/subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ApayaCustomerTokenApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:BinDataApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentResponseProcessorApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:GoCardlessMandateApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:IdealPayNlTokenApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaAddressApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaCustomerTokenApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaPaymentSessionApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaSessionDetailsApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:KlarnaTokenDetails", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalBillingAgreementApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalExternalPayerInfoApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PayPalOrderTokenApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadNotificationConfig", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayloadPayment", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentStatusWebhookPayload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadNotificationConfig", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayloadPayment", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentRefundWebhookPayload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeOpenWebhookPayload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayloadPaymentMethod", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:DisputeStatusWebhookPayload", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:PaymentCardTokenApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:StatusReasonApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:RiskDataApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:FraudCheckApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CvvCheckApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsCheckApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AvsRiskAssessmentValues", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:ThreeDSecureAuthenticationApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:TransactionOverviewApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:AddressApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:OptionalAddressApiSchema", + "ca56f687-5be3-4661-aeed-674a0f1f7193/type-definition/type_:CheckoutCustomerDetailsApiSchema" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-fe590ab9-f9e7-4719-8ec5-b595affff88d.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-fe590ab9-f9e7-4719-8ec5-b595affff88d.json new file mode 100644 index 0000000000..77dfbac3e7 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitionKeys-fe590ab9-f9e7-4719-8ec5-b595affff88d.json @@ -0,0 +1,1194 @@ +[ + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/orderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/currencyCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/order", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/customer", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/metadata", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object/property/paymentMethod", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/status", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/payment_method_type", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/processor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/currency_code", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/from_date", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/to_date", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/order_id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/min_amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/max_amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/customer_id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/merchant_id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/customer_email_address", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/last_4_digits", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/paypal_email", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/klarna_email", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/limit", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/query/cursor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/requestHeader/X-Idempotency-Key", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/orderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/currencyCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/order", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethodToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/customer", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/metadata", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object/property/paymentMethod", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/example/2/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/path/id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/requestHeader/X-Idempotency-Key", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/request/object/property/final", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/example/2/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/path/id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/requestHeader/X-Idempotency-Key", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/request/object/property/reason", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/path/id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/requestHeader/X-Idempotency-Key", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/orderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/request/object/property/reason", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/example/2/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/path/id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/request/object/property/resumeToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/path/id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/path/token", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object/property/customerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/query/customer_id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/path/token", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/path/token", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1/snippet/curl/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CREDIT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEBIT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/PREPAID", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/CHARGE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/DEFERRED_DEBIT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum/shape/enum/value/UNKNOWN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mx", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mnc", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object/property/mcc", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataOptionalApiSchema/shape/object/property/network", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/network", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCountryCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/issuerName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/issuerCurrencyCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/regionalRestriction", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/accountNumberType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/accountFundingType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/prepaidReloadableIndicator", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/productUsageType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/productCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object/property/productName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/3DS_AUTHENTICATION", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BlockingPaymentActionTypeEnum/shape/enum/value/USE_PRIMER_SDK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/PRIMARY_ACCOUNT_NUMBER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/NETWORK_TOKEN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardAccountNumberTypeEnum/shape/enum/value/UNKNOWN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/AMEX", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/DANKORT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/DINERS_CLUB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/DISCOVER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/ENROUTE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/ELO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/HIPER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/INTERAC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/JCB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/MAESTRO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/MASTERCARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/MIR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/PRIVATE_LABEL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/UNIONPAY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/VISA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape/enum/value/OTHER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardProductTypeEnum/shape/enum/value/CONSUMER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardProductTypeEnum/shape/enum/value/BUSINESS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardProductTypeEnum/shape/enum/value/GOVERNMENT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardProductTypeEnum/shape/enum/value/UNKNOWN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/DOMESTIC_USE_ONLY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/NONE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardRegionRestrictionEnum/shape/enum/value/UNKNOWN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/customerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/orderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/currencyCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/metadata", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/customer", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/order", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object/property/paymentMethod", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderDetailsApiSchema/shape/object/property/countryCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderDetailsApiSchema/shape/object/property/fees", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderDetailsApiSchema/shape/object/property/lineItems", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderDetailsApiSchema/shape/object/property/shipping", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderFeesApiSchema/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderFeesApiSchema/shape/object/property/type", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderFeesApiSchema/shape/object/property/description", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/itemId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/description", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/discountAmount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/quantity", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxAmount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/taxCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object/property/productType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderShippingApiSchema/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object/property/PAYMENT_CARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object/property/options", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object/property/surcharge", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object/property/networks", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/AMEX", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DANKORT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DINERS_CLUB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/DISCOVER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ENROUTE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/ELO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/HIPER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/INTERAC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/JCB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MAESTRO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MASTERCARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/MIR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/PRIVATE_LABEL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/UNIONPAY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/VISA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object/property/OTHER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object/property/surcharge", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/vaultOnSuccess", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object/property/paymentType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/3", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/4", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/5", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/6", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape/undiscriminatedUnion/variant/7", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/descriptor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/vaultedPaymentMethodToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/analyticsId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/paymentMethodData", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object/property/threeDSecureAuthentication", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/emailAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/mobileNumber", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/firstName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/lastName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/billingAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/shippingAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/taxId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/emailAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/mobileNumber", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/firstName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/lastName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/billingAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/shippingAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/taxId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object/property/nationalDocumentId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/clientToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/clientTokenExpirationDate", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/orderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/currencyCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/order", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/customerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/customer", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/metadata", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/paymentMethod", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object/property/warnings", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/type", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/code", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionWarningsApiResponse/shape/object/property/message", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AX", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AQ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/AZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BJ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BQ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/BW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CX", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/CZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/DE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/DJ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/DM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/DK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/DO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/DZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/EC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/EG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/EH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ES", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/EE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ET", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/FI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/FJ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/FK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/FR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/FO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/FM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GQ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/HK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/HM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/HN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/HR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/HT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/HU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ID", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IQ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/IT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/JM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/JE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/JO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/JP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/LV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MX", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ML", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ME", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MQ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/MY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/YT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/NZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/OM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/KP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/QA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/RE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/RO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/RU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/RW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/GS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SJ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/PM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/RS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ST", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SX", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/SY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TJ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/TZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/UG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/UA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/UM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/UY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/US", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/UZ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/VA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/VC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/VE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/VG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/VI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/VN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/VU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/WF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/WS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/YE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ZA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ZM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape/enum/value/ZW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/AED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/AFN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ALL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/AMD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ANG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/AOA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ARS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/AUD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/AWG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/AZN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BAM", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BBD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BDT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BGN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BHD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BIF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BMD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BND", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BOB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BOV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BRL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BSD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BTN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BWP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BYR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BYN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/BZD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CAD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CDF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CHE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CHF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CHW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CLF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CLP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CNY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/COP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/COU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CRC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CUC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CUP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CVE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/CZK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/DJF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/DKK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/DOP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/DZD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/EGP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ERN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ETB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/EUR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/FJD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/FKP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GBP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GEL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GHS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GIP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GMD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GNF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GTQ", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/GYD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/HKD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/HNL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/HRK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/HTG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/HUF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/IDR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ILS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/INR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/IQD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/IRR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ISK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/JMD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/JOD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/JPY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KES", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KGS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KHR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KMF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KPW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KRW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KWD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KYD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/KZT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LAK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LBP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LKR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LRD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LSL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LTL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LVL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/LYD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MAD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MDL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MGA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MKD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MMK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MNT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MOP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MRO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MUR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MVR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MWK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MXN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MXV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MYR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/MZN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/NAD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/NGN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/NIO", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/NOK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/NPR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/NZD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/OMR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/PAB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/PEN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/PGK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/PHP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/PKR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/PLN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/PYG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/QAR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/RON", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/RSD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/RUB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/RWF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SAR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SBD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SCR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SDG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SEK", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SGD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SHP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SLL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SOS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SRD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SSP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/STD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SVC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SYP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/SZL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/THB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TJS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TMT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TND", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TOP", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TRY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TTD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TWD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/TZS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/UAH", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/UGX", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/USD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/USN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/USS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/UYI", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/UYU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/UZS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/VEF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/VND", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/VUV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/WST", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XAF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XAG", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XAU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XBA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XBB", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XBC", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XBD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XCD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XDR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XFU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XOF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XPD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XPF", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XPT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XSU", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XTS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/XUA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/YER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ZAR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ZMW", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape/enum/value/ZWL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/name", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/processorMerchantId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountCaptured", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object/property/amountRefunded", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:GoCardlessMandateApiSchema/shape/object/property/gocardlessMandateId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:IdealPayNlTokenApiSchema/shape/object/property/paymentMethodConfigId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/title", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/firstName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/lastName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/email", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/phoneNumber", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/addressLine3", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/city", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/state", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/countryCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object/property/postalCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/klarnaCustomerToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object/property/sessionData", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/klarnaAuthorizationToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object/property/sessionData", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/recurringDescription", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/billingAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/shippingAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCountry", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/purchaseCurrency", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/locale", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/orderLines", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object/property/tokenDetails", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaTokenDetails/shape/object/property/type", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaTokenDetails/shape/object/property/brand", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaTokenDetails/shape/object/property/masked_number", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaTokenDetails/shape/object/property/expiry_date", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalBillingAgreementId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/externalPayerInfo", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/shippingAddress", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object/property/paypalStatus", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/externalPayerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/email", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/firstName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object/property/lastName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalOrderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/externalPayerInfo", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalOrderTokenApiSchema/shape/object/property/paypalStatus", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/date", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/status", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/orderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/currencyCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/order", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/customerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/customer", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/metadata", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/paymentMethod", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/processor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/requiredAction", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/statusReason", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object/property/transactions", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/first6Digits", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/last4Digits", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationMonth", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/expirationYear", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/cardholderName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/network", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/isNetworkTokenized", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object/property/binData", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:StatusReasonApiSchema/shape/object/property/type", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:StatusReasonApiSchema/shape/object/property/declineType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:StatusReasonApiSchema/shape/object/property/code", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:StatusReasonApiSchema/shape/object/property/message", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYMENT_CARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYPAL_ORDER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAYPAL_BILLING_AGREEMENT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/GOCARDLESS_MANDATE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/KLARNA_AUTHORIZATION_TOKEN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/KLARNA_CUSTOMER_TOKEN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/PAY_NL_IDEAL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APAYA", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/OFF_SESSION_PAYMENT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/CARD_OFF_SESSION_PAYMENT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APPLE_PAY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/APPLE_PAY_ENCRYPTED_TOKEN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape/enum/value/GOOGLE_PAY", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentListApiResponse/shape/object/property/data", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentListApiResponse/shape/object/property/nextCursor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentListApiResponse/shape/object/property/prevCursor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/name", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/description", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequiredActionApiSchema/shape/object/property/clientToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/id", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/date", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/status", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/orderId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/processor", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/currencyCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/amount", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object/property/metadata", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/name", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object/property/processorMerchantId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/RELOADABLE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NON_RELOADABLE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/NOT_APPLICABLE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PrepaidReloadableEnum/shape/enum/value/UNKNOWN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/FIRST_PAYMENT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/ECOMMERCE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/SUBSCRIPTION", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:RecurringTransactionTypeEnum/shape/enum/value/UNSCHEDULED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ProductTypeEnum/shape/enum/value/PHYSICAL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ProductTypeEnum/shape/enum/value/DIGITAL", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/NOT_PERFORMED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/SKIPPED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_SUCCESS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/AUTH_FAILED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/CHALLENGE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape/enum/value/METHOD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape/undiscriminatedUnion/variant/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/responseCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/reasonText", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/protocolVersion", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object/property/challengeIssued", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REJECTED_BY_ISSUER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARD_AUTHENTICATION_FAILED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNKNOWN_DEVICE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/UNSUPPORTED_DEVICE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXPIRED_CARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_CARD_NUMBER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_TRANSACTION", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NO_CARD_RECORD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SECURITY_FAILURE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/STOLEN_CARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/SUSPECTED_FRAUD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/CARDHOLDER_NOT_ENROLLED_IN_SERVICE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_TIMED_OUT_AT_THE_ACS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/LOW_CONFIDENCE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/MEDIUM_CONFIDENCE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/HIGH_CONFIDENCE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/VERY_HIGH_CONFIDENCE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/EXCEEDS_ACS_MAXIMUM_CHALLENGES", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/NON_PAYMENT_NOT_SUPPORTED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/THREE_RI_NOT_SUPPORTED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TECHNICAL_ISSUE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_REQUIRED_BY_ACS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_MAX_EXPIRY_EXCEEDED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_TIMED_OUT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/INVALID_ACS_RESPONSE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ACS_SYSTEM_ERROR_RESPONSE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/ERROR_GENERATING_CAVV", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/PROTOCOL_VERSION_NOT_SUPPORTED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape/enum/value/REQUESTED_PROGRAM_NOT_SUPPORTED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/GATEWAY_UNAVAILABLE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/DISABLED_BY_MERCHANT", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/NOT_SUPPORTED_BY_ISSUER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/FAILED_TO_NEGOTIATE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/UNKNOWN_ACS_RESPONSE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/3DS_SERVER_ERROR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_CONFIGURED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape/enum/value/ACQUIRER_NOT_PARTICIPATING", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TokenTypeEnum/shape/enum/value/MULTI_USE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TokenTypeEnum/shape/enum/value/SINGLE_USE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:DeclineTypeEnum/shape/enum/value/SOFT_DECLINE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:DeclineTypeEnum/shape/enum/value/HARD_DECLINE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ERROR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INVALID_CARD_NUMBER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/EXPIRED_CARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/LOST_OR_STOLEN_CARD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/SUSPECTED_FRAUD", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/UNKNOWN", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DECLINED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/REFER_TO_CARD_ISSUER", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/DO_NOT_HONOR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/INSUFFICIENT_FUNDS", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/WITHDRAWAL_LIMIT_EXCEEDED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/ISSUER_TEMPORARILY_UNAVAILABLE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape/enum/value/AUTHENTICATION_REQUIRED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/transactionType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorTransactionId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorMerchantId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatus", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape/object/property/processorStatusReason", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/PENDING", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/FAILED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/AUTHORIZED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/SETTLING", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/PARTIALLY_SETTLED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/SETTLED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/DECLINED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape/enum/value/CANCELLED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/APPLICATION_ERROR", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/GATEWAY_REJECTED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatusTypeEnum/shape/enum/value/ISSUER_DECLINED", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionTypeEnum/shape/enum/value/SALE", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionTypeEnum/shape/enum/value/REFUND", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/firstName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/lastName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/addressLine1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/addressLine2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/city", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/state", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/countryCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object/property/postalCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/firstName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/lastName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/addressLine1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/addressLine2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/city", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/state", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/countryCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object/property/postalCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/3", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape/undiscriminatedUnion/variant/4", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/createdAt", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deletedAt", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/deleted", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/token", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/tokenType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/analyticsId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/paymentMethodData", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/customerId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object/property/default", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenListApiResponse/shape/object/property/data", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/last4Digits", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/expirationMonth", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/expirationYear", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/cardholderName", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/network", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/networkTransactionId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object/property/accountFundingType", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ErrorObject/shape/object/property/errorId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ErrorObject/shape/object/property/description", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ErrorObject/shape/object/property/recoverySuggestion", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ErrorObject/shape/object/property/diagnosticsId", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/error/0/422/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/error/1/422/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/error/1/422/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/error/1/422/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/422/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/response", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400/error/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:four_hundred_ErrorResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:four_hundred_twenty_two_ErrorResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/request/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/request/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/request/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/request/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ApayaCustomerTokenApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataOptionalApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderDetailsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderFeesApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderShippingApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionWarningsApiResponse/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponseProcessorApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:GoCardlessMandateApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:IdealPayNlTokenApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaCustomerTokenApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaPaymentSessionApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaTokenDetails/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalBillingAgreementApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalOrderTokenApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:StatusReasonApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentListApiResponse/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequiredActionApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryProcessorApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenListApiResponse/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ErrorObject/shape/object", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BlockingPaymentActionTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardAccountNumberTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardProductTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardRegionRestrictionEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PrepaidReloadableEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:RecurringTransactionTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ProductTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TokenTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:DeclineTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatusTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionTypeEnum/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:four_hundred_ErrorResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:four_hundred_twenty_two_ErrorResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/error/1/422", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/example/2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/error/0/422", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/error/1/422", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/example/2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/error/1/422", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/example/2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/error/1/422", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/example/2", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/error/0/422", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/error/0/400", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/0", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post/example/1", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken/request", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment/request", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment/request", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment/request", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment/request", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment/request", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post/request", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AccountFundingTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ApayaCustomerTokenApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataOptionalApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BlockingPaymentActionTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardAccountNumberTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardNetworkEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardProductTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CardRegionRestrictionEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderDetailsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderFeesApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderShippingApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionWarningsApiResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CountryCodeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:Currency", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponseProcessorApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:GoCardlessMandateApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:IdealPayNlTokenApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaCustomerTokenApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaPaymentSessionApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaTokenDetails/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalBillingAgreementApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalExternalPayerInfoApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalOrderTokenApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:StatusReasonApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentMethodTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentListApiResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequiredActionApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryProcessorApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PrepaidReloadableEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:RecurringTransactionTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ProductTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthResponseCodeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchemaReasonCode", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureFailedReasonCodeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureSkippedReasonCodeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TokenTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:DeclineTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionDeclineReasonV2Enum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatus", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentStatusTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionTypeEnum", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenListApiResponse/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ErrorObject/shape", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ApayaCustomerTokenApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataOptionalApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:BinDataApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionUpdateApiRequest", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderDetailsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderFeesApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderLineItemsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:OrderShippingApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchemaOptions", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodCardOptionApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutPaymentMethodOptionSurchargeApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequestPaymentMethodOptionsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponsePaymentMethodOptionsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CheckoutCustomerDetailsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CustomerDetailsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionApiResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ClientSessionWarningsApiResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentResponseProcessorApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:GoCardlessMandateApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:IdealPayNlTokenApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaAddressApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaCustomerTokenApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaPaymentSessionApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaSessionDetailsApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:KlarnaTokenDetails", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalBillingAgreementApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalExternalPayerInfoApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PayPalOrderTokenApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentApiResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:StatusReasonApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentListApiResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentRequiredActionApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentSummaryProcessorApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ThreeDSecureAuthenticationApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:TransactionOverviewApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:CoreApiApiCommonsSchemasAddessAddressApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:AddressApiSchema", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenApiResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:MerchantPaymentMethodTokenListApiResponse", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:PaymentCardTokenApiSchemaPaymentMethodsApi", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/type-definition/type_:ErrorObject", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_clientSessionApi.createClientSideToken", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.listPayments", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.createPayment", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.capturePayment", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.cancelPayment", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.refundPayment", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.resumePayment", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentsApi.getPaymentById", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "fe590ab9-f9e7-4719-8ec5-b595affff88d/endpoint/subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/primer/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitions.json new file mode 100644 index 0000000000..7711b116ff --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/primer/apiDefinitions.json @@ -0,0 +1,63437 @@ +[ + { + "id": "3e1141df-b4bc-4dab-9542-53cf91851645", + "endpoints": { + "subpackage_paymentWebhooks.payment_status_webhook_event": { + "id": "subpackage_paymentWebhooks.payment_status_webhook_event", + "namespace": [ + "subpackage_paymentWebhooks" + ], + "description": "Primer notifies you with a `PAYMENT.STATUS` webhook when a payment's status has been updated. This is especially useful for asynchronous processor Connections, which do not respond with an upfront authorization.\nThe webhook body contains the full payment object.\n\nExample payment status notification:\n\n```JSON\n{\n \"eventType\":\"PAYMENT.STATUS\",\n \"date\":\"2021-02-21T15:36:16.367687\",\n \"notificationConfig\":{\n \"id\":\"cc51f9f0-7e1c-492b-9d37-f83a818f6070\",\n \"description\":\"Payment webhook\"\n },\n \"signedAt\": \"1689221338\",\n \"version\":\"2.1\",\n \"payment\":{\n \"id\":\"DdRZ6YY0\",\n \"date\":\"2022-01-01T12:12:12.000000\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"customerId\":\"cust-123\",\n \"orderId\":\"order-123\",\n \"status\":\"SETTLED\",\n \"paymentMethod\":{\n \"paymentType\":\"FIRST_PAYMENT\",\n \"paymentMethodToken\":\"-lcWjvBAAs2DnIRXwxNjUzNTYzNjIy\",\n \"analyticsId\":\"LUi5pETUaVsdSEamK25L\",\n \"paymentMethodType\":\"PAYMENT_CARD\",\n \"paymentMethodData\":{\n \"last4Digits\":\"1111\",\n \"expirationMonth\":\"03\",\n \"expirationYear\":\"2030\",\n \"cardholderName\":\"ADYEN\",\n \"network\":\"Visa\",\n \"isNetworkTokenized\":false,\n \"binData\":{\n \"network\":\"VISA\",\n \"issuerCountryCode\":\"US\",\n \"issuerName\":\"JPMORGAN CHASE BANK, N.A.\",\n \"regionalRestriction\":\"UNKNOWN\",\n \"accountNumberType\":\"UNKNOWN\",\n \"accountFundingType\":\"UNKNOWN\",\n \"prepaidReloadableIndicator\":\"NOT_APPLICABLE\",\n \"productUsageType\":\"UNKNOWN\",\n \"productCode\":\"UNKNOWN\",\n \"productName\":\"UNKNOWN\"\n }\n },\n \"threeDSecureAuthentication\":{\n \"responseCode\":\"NOT_PERFORMED\"\n }\n },\n \"processor\":{\n \"name\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORasdasqNWFwi8c\",\n \"amountCaptured\":3000,\n \"amountRefunded\":0\n },\n \"transactions\":[\n {\n \"date\":\"2022-05-26T11:14:11.946300\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"transactionType\":\"SALE\",\n \"processorTransactionId\":\"pi_3L3edsGZasdasdc1iget38p\",\n \"processorName\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORasvasdNWFwi8c\",\n \"processorStatus\":\"SETTLED\"\n }\n ]\n }\n}\n```\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `PAYMENT.STATUS` in this case." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date-time that the webhook was sent." + }, + { + "key": "notificationConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_paymentWebhooks:PaymentStatusWebhookPayloadNotificationConfig" + } + }, + "description": "The notification configuration details." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "signedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Timestamp when the webhook content was signed" + }, + { + "key": "payment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_paymentWebhooks:PaymentStatusWebhookPayloadPayment" + } + } + } + ] + } + }, + "examples": [ + { + "path": "/payment-status", + "responseStatusCode": 204, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "notificationConfig": {}, + "version": "2.1", + "signedAt": "1689221338", + "payment": { + "status": "PENDING", + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "string", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": {}, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "2024-01-15T09:30:00Z", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "string", + "transactionType": "SALE", + "processorStatus": "PENDING", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-status \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"notificationConfig\": {},\n \"version\": \"2.1\",\n \"signedAt\": \"1689221338\",\n \"payment\": {\n \"status\": \"PENDING\",\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"paymentMethodData\": {\n \"last4Digits\": \"string\",\n \"expirationMonth\": \"string\",\n \"expirationYear\": \"string\",\n \"binData\": {\n \"network\": \"string\",\n \"issuerCountryCode\": \"AW\",\n \"issuerCurrencyCode\": \"AED\",\n \"regionalRestriction\": \"DOMESTIC_USE_ONLY\",\n \"accountNumberType\": \"PRIMARY_ACCOUNT_NUMBER\",\n \"accountFundingType\": \"CREDIT\",\n \"prepaidReloadableIndicator\": \"RELOADABLE\",\n \"productUsageType\": \"CONSUMER\",\n \"productCode\": \"string\",\n \"productName\": \"string\"\n }\n },\n \"threeDSecureAuthentication\": {\n \"responseCode\": \"NOT_PERFORMED\",\n \"reasonCode\": \"GATEWAY_UNAVAILABLE\"\n }\n },\n \"processor\": {},\n \"statusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n },\n \"transactions\": [\n {\n \"date\": \"2024-01-15T09:30:00Z\",\n \"amount\": 1,\n \"currencyCode\": \"string\",\n \"processorMerchantId\": \"string\",\n \"transactionType\": \"SALE\",\n \"processorStatus\": \"PENDING\",\n \"processorStatusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n }\n }\n ]\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentWebhooks.payment_refund_webhook_event": { + "id": "subpackage_paymentWebhooks.payment_refund_webhook_event", + "namespace": [ + "subpackage_paymentWebhooks" + ], + "description": "Primer notifies you with a `PAYMENT.REFUND` Webhook when a refund request has been fully processed by a payment processor and the refund has reached a final state.\n\nCheck the transaction with the most recent `transactionType: \"REFUND\"` in the `transactions` array:\n\n- if `processorStatus` is `SETTLED`, the refund was successful and the funds have been returned to the customer\n- if `processorStatus` is `FAILED`, the refund was unsuccessful\n\nExample refund notification:\n\n```JSON\n{\n \"eventType\":\"PAYMENT.REFUND\",\n \"date\":\"2021-02-21T15:36:16.367687\",\n \"notificationConfig\":{\n \"id\":\"cc51f9f0-7e1c-492b-9d37-f83a818f6070\",\n \"description\":\"Refund webhook\"\n },\n \"signedAt\": \"1689221338\",\n \"version\":\"2.1\",\n \"payment\":{\n \"id\":\"DdRZ6YY0\",\n \"date\":\"2022-01-01T12:12:12.000000\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"customerId\":\"cust-123\",\n \"orderId\":\"order-123\",\n \"status\":\"SETTLED\",\n \"paymentMethod\":{\n \"paymentMethodToken\":\"-lcWjvBASh2EpYaHgVwxNjUzNTYzNjIy\",\n \"analyticsId\":\"LUi5pETUV2EpYaHgV77SEamK25L\",\n \"paymentMethodType\":\"PAYMENT_CARD\",\n \"paymentMethodData\":{\n \"paymentType\":\"FIRST_PAYMENT\",\n \"last4Digits\":\"1111\",\n \"expirationMonth\":\"03\",\n \"expirationYear\":\"2030\",\n \"cardholderName\":\"ADYEN\",\n \"network\":\"Visa\",\n \"isNetworkTokenized\":false,\n \"binData\":{\n \"network\":\"VISA\",\n \"issuerCountryCode\":\"US\",\n \"issuerName\":\"JPMORGAN CHASE BANK, N.A.\",\n \"regionalRestriction\":\"UNKNOWN\",\n \"accountNumberType\":\"UNKNOWN\",\n \"accountFundingType\":\"UNKNOWN\",\n \"prepaidReloadableIndicator\":\"NOT_APPLICABLE\",\n \"productUsageType\":\"UNKNOWN\",\n \"productCode\":\"UNKNOWN\",\n \"productName\":\"UNKNOWN\"\n }\n },\n \"threeDSecureAuthentication\":{\n \"responseCode\":\"NOT_PERFORMED\"\n }\n },\n \"processor\":{\n \"name\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1G2EpYaHgVZqNWFwi8c\",\n \"amountCaptured\":3000,\n \"amountRefunded\":3000\n },\n \"transactions\":[\n {\n \"date\":\"2022-05-26T11:14:11.946300\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"transactionType\":\"SALE\",\n \"processorTransactionId\":\"pi_3L3ed23NWFwiNWFwi8c1iget38p\",\n \"processorName\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORcaGv23NWFwi8c\",\n \"processorStatus\":\"SETTLED\"\n },\n {\n \"date\":\"2022-05-26T11:14:11.946300\",\n \"amount\":3001,\n \"currencyCode\":\"GBP\",\n \"transactionType\":\"REFUND\",\n \"processorTransactionId\":\"pi_3L3ed23NWFwiNWFwi8c1iget38p\",\n \"processorName\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORcaGv23NWFwi8c\",\n \"processorStatus\":\"FAILED\",\n \"processorStatusReason\":{\n \"type\":\"APPLICATION_ERROR\",\n \"declineType\":\"SOFT_DECLINE\",\n \"code\":\"UNKNOWN\",\n \"message\":\"Refund amount too large\"\n }\n }\n ]\n }\n}\n```\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-refund" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `PAYMENT.REFUND` in this case." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date-time that the webhook was sent." + }, + { + "key": "notificationConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_paymentWebhooks:PaymentRefundWebhookPayloadNotificationConfig" + } + }, + "description": "The notification configuration details." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "signedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Timestamp when the webhook content was signed" + }, + { + "key": "payment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_paymentWebhooks:PaymentRefundWebhookPayloadPayment" + } + } + } + ] + } + }, + "examples": [ + { + "path": "/payment-refund", + "responseStatusCode": 204, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "notificationConfig": {}, + "version": "2.1", + "signedAt": "1689221338", + "payment": { + "status": "PENDING", + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "string", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": {}, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "2024-01-15T09:30:00Z", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "string", + "transactionType": "SALE", + "processorStatus": "PENDING", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-refund \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"notificationConfig\": {},\n \"version\": \"2.1\",\n \"signedAt\": \"1689221338\",\n \"payment\": {\n \"status\": \"PENDING\",\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"paymentMethodData\": {\n \"last4Digits\": \"string\",\n \"expirationMonth\": \"string\",\n \"expirationYear\": \"string\",\n \"binData\": {\n \"network\": \"string\",\n \"issuerCountryCode\": \"AW\",\n \"issuerCurrencyCode\": \"AED\",\n \"regionalRestriction\": \"DOMESTIC_USE_ONLY\",\n \"accountNumberType\": \"PRIMARY_ACCOUNT_NUMBER\",\n \"accountFundingType\": \"CREDIT\",\n \"prepaidReloadableIndicator\": \"RELOADABLE\",\n \"productUsageType\": \"CONSUMER\",\n \"productCode\": \"string\",\n \"productName\": \"string\"\n }\n },\n \"threeDSecureAuthentication\": {\n \"responseCode\": \"NOT_PERFORMED\",\n \"reasonCode\": \"GATEWAY_UNAVAILABLE\"\n }\n },\n \"processor\": {},\n \"statusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n },\n \"transactions\": [\n {\n \"date\": \"2024-01-15T09:30:00Z\",\n \"amount\": 1,\n \"currencyCode\": \"string\",\n \"processorMerchantId\": \"string\",\n \"transactionType\": \"SALE\",\n \"processorStatus\": \"PENDING\",\n \"processorStatusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n }\n }\n ]\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event": { + "id": "subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event", + "namespace": [ + "subpackage_disputeChargebacksWebhooks" + ], + "description": "Primer notifies you with a `DISPUTE.OPEN` webhook on newly opened disputes or chargebacks. This notification is unified across all processors.\n\nExample of dispute event:\n\n```JSON\n{\n \"eventType\":\"DISPUTE.OPENED\",\n \"version\":\"2.1\",\n \"primerAccountId\":\"7fcd50f1-99f2-416e-8013-6ecd1c1285c3\",\n \"transactionId\":\"c3f662ad-d197-492e-b78b-63eefa64a31d\",\n \"orderId\":\"order-123\",\n \"processorId\":\"Adyen\",\n \"processorDisputeId\":\"adyen_ref_123\",\n \"paymentId\":\"ecb8d3bc-805d-4d97-826e-ef8d4cc3d2a2\",\n \"raw_processor_callback\":{\n \"example\":{\n \"raw_callback\":\"request\",\n \"from\":\"Adyen\"\n }\n }\n}\n```\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/dispute-opened" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `DISPUTE.OPEN` in this case." + }, + { + "key": "processorId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the processor that generated the dispute." + }, + { + "key": "processorDisputeId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the corresponding connection dispute." + }, + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer payment corresponding to this dispute." + }, + { + "key": "transactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer transaction corresponding to this dispute." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the sale transaction that the dispute relates to." + }, + { + "key": "primerAccountId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your Primer merchant account." + } + ] + } + }, + "examples": [ + { + "path": "/dispute-opened", + "responseStatusCode": 204, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/dispute-opened \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_paymentWebhooks:PaymentStatusWebhookPayloadNotificationConfig": { + "name": "PaymentStatusWebhookPayloadNotificationConfig", + "description": "The notification configuration details.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration ID." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration description." + } + ] + } + }, + "type_paymentWebhooks:PaymentStatusWebhookPayloadPayment": { + "name": "PaymentStatusWebhookPayloadPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream operations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + } + ] + } + }, + "type_paymentWebhooks:PaymentRefundWebhookPayloadNotificationConfig": { + "name": "PaymentRefundWebhookPayloadNotificationConfig", + "description": "The notification configuration details.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration ID." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration description." + } + ] + } + }, + "type_paymentWebhooks:PaymentRefundWebhookPayloadPayment": { + "name": "PaymentRefundWebhookPayloadPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream operations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + } + ] + } + }, + "type_:AccountFundingTypeEnum": { + "name": "AccountFundingTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT" + }, + { + "value": "DEBIT" + }, + { + "value": "PREPAID" + }, + { + "value": "CHARGE" + }, + { + "value": "DEFERRED_DEBIT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ApayaCustomerTokenApiSchema": { + "name": "ApayaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mx", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mnc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "mcc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BinDataApiSchema": { + "name": "BinDataApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuerCurrencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + } + }, + { + "key": "regionalRestriction", + "valueShape": { + "type": "id", + "id": "type_:CardRegionRestrictionEnum" + } + }, + { + "key": "accountNumberType", + "valueShape": { + "type": "id", + "id": "type_:CardAccountNumberTypeEnum" + } + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + { + "key": "prepaidReloadableIndicator", + "valueShape": { + "type": "id", + "id": "type_:PrepaidReloadableEnum" + } + }, + { + "key": "productUsageType", + "valueShape": { + "type": "id", + "id": "type_:CardProductTypeEnum" + } + }, + { + "key": "productCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "productName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:CardAccountNumberTypeEnum": { + "name": "CardAccountNumberTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PRIMARY_ACCOUNT_NUMBER" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardNetworkEnum": { + "name": "CardNetworkEnum", + "description": "[The list of available card networks and their `CARD_NETWORK_TYPE` can be found here.](https://www.notion.so/primerio/Payment-Method-Types-2b971a8c54c3452cae0b2fffe9167d72)", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:CardProductTypeEnum": { + "name": "CardProductTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CONSUMER" + }, + { + "value": "BUSINESS" + }, + { + "value": "GOVERNMENT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardRegionRestrictionEnum": { + "name": "CardRegionRestrictionEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DOMESTIC_USE_ONLY" + }, + { + "value": "NONE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData": { + "name": "PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Order Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalOrderTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Payment Session Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaPaymentSessionApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Ideal Pay Nl Token Api Schema", + "shape": { + "type": "id", + "id": "type_:IdealPayNlTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchema": { + "name": "PaymentResponsePaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment method token used to authorize the transaction." + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type" + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchema" + } + } + } + ] + } + }, + "type_:CountryCodeEnum": { + "name": "CountryCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:Currency": { + "name": "Currency", + "description": "Enumerates all supported currencies", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentResponseProcessorApiSchema": { + "name": "PaymentResponseProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + }, + { + "key": "amountCaptured", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no capture was performed, this value will be set to `0`.\n\nIf one or more partial captures were performed, this value will be a sum\nof all partial capture amounts." + }, + { + "key": "amountRefunded", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no refund was performed, this value will be set to `0`.\n\nIf one or more partial refunds were performed, this value will be a sum\nof all partial refund amounts." + } + ] + } + }, + "type_:GoCardlessMandateApiSchema": { + "name": "GoCardlessMandateApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gocardlessMandateId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of a GoCardless mandate agreement" + } + ] + } + }, + "type_:IdealPayNlTokenApiSchema": { + "name": "IdealPayNlTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodConfigId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:KlarnaAddressApiSchema": { + "name": "KlarnaAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "phoneNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine3", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:KlarnaCustomerTokenApiSchema": { + "name": "KlarnaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaCustomerToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaPaymentSessionApiSchema": { + "name": "KlarnaPaymentSessionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaAuthorizationToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaSessionDetailsApiSchema": { + "name": "KlarnaSessionDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "recurringDescription", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "billingAddress", + "valueShape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + } + }, + { + "key": "purchaseCountry", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "purchaseCurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "locale", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "orderLines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "key": "tokenDetails", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaTokenDetails" + } + } + } + ] + } + }, + "type_:KlarnaTokenDetails": { + "name": "KlarnaTokenDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "masked_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiry_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalBillingAgreementApiSchema": { + "name": "PayPalBillingAgreementApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalBillingAgreementId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddressApiSchema" + } + }, + "description": "The PayPal customer's shipping address" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalExternalPayerInfoApiSchema": { + "name": "PayPalExternalPayerInfoApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalPayerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalOrderTokenApiSchema": { + "name": "PayPalOrderTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalOrderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentCardTokenApiSchema": { + "name": "PaymentCardTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "isNetworkTokenized", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BinDataApiSchema" + } + } + } + ] + } + }, + "type_:StatusReasonApiSchema": { + "name": "StatusReasonApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatusTypeEnum" + }, + "description": "Type of the status." + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeclineTypeEnum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED` this will be returned.\n\nDeclines of type `SOFT_DECLINE` may be retried,\nwhereas declines of type `HARD_DECLINE` should not be retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionDeclineReasonV2Enum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED`, this will be returned." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "In case of an error on the processor's part, we will return the message returned by the processor. This is usually a human readable error." + } + ] + } + }, + "type_:PaymentMethodTypeEnum": { + "name": "PaymentMethodTypeEnum", + "description": "[The list of available payment methods and their `PAYMENT_METHOD_TYPE` can be found here.](https://www.notion.so/primerio/Payment-Method-Types-2b971a8c54c3452cae0b2fffe9167d72)", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:PrepaidReloadableEnum": { + "name": "PrepaidReloadableEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RELOADABLE" + }, + { + "value": "NON_RELOADABLE" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ThreeDSecureAuthResponseCodeEnum": { + "name": "ThreeDSecureAuthResponseCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchemaReasonCode": { + "name": "ThreeDSecureAuthenticationApiSchemaReasonCode", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Three D Secure Skipped Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureSkippedReasonCodeEnum" + } + }, + { + "displayName": "Three D Secure Failed Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureFailedReasonCodeEnum" + } + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchema": { + "name": "ThreeDSecureAuthenticationApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "responseCode", + "valueShape": { + "type": "id", + "id": "type_:ThreeDSecureAuthResponseCodeEnum" + } + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchemaReasonCode" + } + } + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ThreeDSecureFailedReasonCodeEnum": { + "name": "ThreeDSecureFailedReasonCodeEnum", + "description": "This enum is derived from the `transStatusReason` on page 218 of the\n[EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/uploads/documents/EMVCo_3DS_Spec_v220_122018.pdf)\n\n| Code | Description |\n| ---- | --------------------------------------- |\n| 01 | Card authentication failed |\n| 02 | Unknown Device |\n| 03 | Unsupported Device |\n| 04 | Exceeds authentication frequency limit |\n| 05 | Expired card |\n| 06 | Invalid card number |\n| 07 | Invalid transaction |\n| 08 | No Card record |\n| 09 | Security failure |\n| 10 | Stolen card |\n| 11 | Suspected fraud |\n| 12 | Transaction not permitted to cardholder |\n| 13 | Cardholder not enrolled in service |\n| 14 | Transaction timed out at the ACS |\n| 15 | Low confidence |\n| 16 | Medium confidence |", + "shape": { + "type": "enum", + "values": [ + { + "value": "UNKNOWN" + }, + { + "value": "REJECTED_BY_ISSUER" + }, + { + "value": "CARD_AUTHENTICATION_FAILED" + }, + { + "value": "UNKNOWN_DEVICE" + }, + { + "value": "UNSUPPORTED_DEVICE" + }, + { + "value": "EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "INVALID_TRANSACTION" + }, + { + "value": "NO_CARD_RECORD" + }, + { + "value": "SECURITY_FAILURE" + }, + { + "value": "STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER" + }, + { + "value": "CARDHOLDER_NOT_ENROLLED_IN_SERVICE" + }, + { + "value": "TRANSACTION_TIMED_OUT_AT_THE_ACS" + }, + { + "value": "LOW_CONFIDENCE" + }, + { + "value": "MEDIUM_CONFIDENCE" + }, + { + "value": "HIGH_CONFIDENCE" + }, + { + "value": "VERY_HIGH_CONFIDENCE" + }, + { + "value": "EXCEEDS_ACS_MAXIMUM_CHALLENGES" + }, + { + "value": "NON_PAYMENT_NOT_SUPPORTED" + }, + { + "value": "THREE_RI_NOT_SUPPORTED" + }, + { + "value": "ACS_TECHNICAL_ISSUE" + }, + { + "value": "DECOUPLED_REQUIRED_BY_ACS" + }, + { + "value": "DECOUPLED_MAX_EXPIRY_EXCEEDED" + }, + { + "value": "DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME" + }, + { + "value": "AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER" + }, + { + "value": "ACS_TIMED_OUT" + }, + { + "value": "INVALID_ACS_RESPONSE" + }, + { + "value": "ACS_SYSTEM_ERROR_RESPONSE" + }, + { + "value": "ERROR_GENERATING_CAVV" + }, + { + "value": "PROTOCOL_VERSION_NOT_SUPPORTED" + }, + { + "value": "TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING" + }, + { + "value": "REQUESTED_PROGRAM_NOT_SUPPORTED" + } + ] + } + }, + "type_:ThreeDSecureSkippedReasonCodeEnum": { + "name": "ThreeDSecureSkippedReasonCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "GATEWAY_UNAVAILABLE" + }, + { + "value": "DISABLED_BY_MERCHANT" + }, + { + "value": "NOT_SUPPORTED_BY_ISSUER" + }, + { + "value": "FAILED_TO_NEGOTIATE" + }, + { + "value": "UNKNOWN_ACS_RESPONSE" + }, + { + "value": "3DS_SERVER_ERROR" + }, + { + "value": "ACQUIRER_NOT_CONFIGURED" + }, + { + "value": "ACQUIRER_NOT_PARTICIPATING" + } + ] + } + }, + "type_:DeclineTypeEnum": { + "name": "DeclineTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:TransactionDeclineReasonV2Enum": { + "name": "TransactionDeclineReasonV2Enum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:TransactionOverviewApiSchema": { + "name": "TransactionOverviewApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The date-time that the transaction was created." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The amount of the transaction, in minor units." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "transactionType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionTypeEnum" + } + } + }, + { + "key": "processorTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Processor's unique identifier for the transaction" + }, + { + "key": "processorName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier of a processor." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Processor's main account identifier.\n\n- Adyen: Account code\n- Braintree: Merchant ID\n- Stripe: Account ID\"" + }, + { + "key": "processorStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Transaction status, please refer to the [Transaction Status Codes](#section/API-Usage-Guide/Payment-Status) table for more information" + }, + { + "key": "processorStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "If the transaction has a declined or failed status.\n\nOnly if the status is `DECLINED` or `FAILED`, otherwise `null`." + } + ] + } + }, + "type_:PaymentStatus": { + "name": "PaymentStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "FAILED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "SETTLED" + }, + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + } + ] + } + }, + "type_:PaymentStatusTypeEnum": { + "name": "PaymentStatusTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:TransactionTypeEnum": { + "name": "TransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SALE" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:AddressApiSchema": { + "name": "AddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "id", + "id": "type_:CountryCodeEnum" + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:RecurringTransactionTypeEnum": { + "name": "RecurringTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + } + ] + } + }, + "type_:RecurringPaymentTypeSchema": { + "name": "RecurringPaymentTypeSchema", + "description": "Payment types, primarily to be used for recurring payments.\nNote: If you successfully vault a `SINGLE_USE` token on payment creation, then there's no need to set a value for this field and it will be flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all possible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RecurringTransactionTypeEnum" + } + } + } + }, + "subpackages": { + "subpackage_paymentWebhooks": { + "id": "subpackage_paymentWebhooks", + "name": "paymentWebhooks" + }, + "subpackage_disputeChargebacksWebhooks": { + "id": "subpackage_disputeChargebacksWebhooks", + "name": "disputeChargebacksWebhooks" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-API-KEY", + "nameOverride": "apiKey" + } + } + }, + { + "id": "ca56f687-5be3-4661-aeed-674a0f1f7193", + "endpoints": {}, + "websockets": {}, + "webhooks": { + "subpackage_paymentWebhooks.payment_status_webhook_event": { + "id": "subpackage_paymentWebhooks.payment_status_webhook_event", + "namespace": [ + "subpackage_paymentWebhooks" + ], + "description": "Primer notifies you with a `PAYMENT.STATUS` webhook when a payment's status has been updated. This is especially useful for asyncronous processor Connections, which do not respond with an upfront authorization.\nThe webhook events will arrive in the order that the payment status changes, for example you should expect a status of `PENDING`, then `AUTHORIZED`, then `SETTLED` (depending on how your workflow is set up).\nThe webhook body contains the full payment object.\n\nExample payment status notification:\n\n```JSON\n{\n \"eventType\":\"PAYMENT.STATUS\",\n \"date\":\"2021-02-21T15:36:16.367687\",\n \"notificationConfig\":{\n \"id\":\"cc51f9f0-7e1c-492b-9d37-f83a818f6070\",\n \"description\":\"Payment webhook\"\n },\n \"version\":\"2.3\",\n \"signedAt\": \"1689221338\",\n \"payment\":{\n \"id\":\"DdRZ6YY0\",\n \"date\":\"2021-02-21T15:34:16.367687\",\n \"dateUpdated\":\"2021-02-21T15:35:16.133701\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"customerId\":\"cust-123\",\n \"orderId\":\"order-123\",\n \"status\":\"SETTLED\",\n \"cardTokenType\":\"CARD_PAN\",\n \"customer\": {\n \"emailAddress\": \"test@primer.io\",\n \"mobileNumber\": \"0123456789\",\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"postalCode\": \"CB94BQ\",\n \"addressLine1\": \"10001 Alpha St\",\n \"countryCode\": \"GB\",\n \"city\": \"Cambridge\",\n \"state\": \"Cambridgeshire\"\n }\n },\n \"paymentMethod\":{\n \"paymentType\":\"FIRST_PAYMENT\",\n \"paymentMethodToken\":\"-lcWjvBAAs2DnIRXwxNjUzNTYzNjIy\",\n \"isVaulted\": \"false\",\n \"analyticsId\":\"LUi5pETUaVsdSEamK25L\",\n \"paymentMethodType\":\"PAYMENT_CARD\",\n \"paymentMethodData\":{\n \"last4Digits\":\"1111\",\n \"first6Digits\": \"411111\",\n \"expirationMonth\":\"03\",\n \"expirationYear\":\"2030\",\n \"cardholderName\":\"ADYEN\",\n \"network\":\"Visa\",\n \"isNetworkTokenized\":false,\n \"binData\":{\n \"network\":\"VISA\",\n \"issuerCountryCode\":\"US\",\n \"issuerName\":\"JPMORGAN CHASE BANK, N.A.\",\n \"regionalRestriction\":\"UNKNOWN\",\n \"accountNumberType\":\"UNKNOWN\",\n \"accountFundingType\":\"UNKNOWN\",\n \"prepaidReloadableIndicator\":\"NOT_APPLICABLE\",\n \"productUsageType\":\"UNKNOWN\",\n \"productCode\":\"UNKNOWN\",\n \"productName\":\"UNKNOWN\"\n }\n },\n \"authorizationType\": \"FINAL\",\n \"threeDSecureAuthentication\":{\n \"responseCode\":\"NOT_PERFORMED\"\n }\n },\n \"processor\":{\n \"name\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORasdasqNWFwi8c\",\n \"amountCaptured\":3000,\n \"amountRefunded\":0\n },\n \"transactions\":[\n {\n \"date\":\"2021-02-21T15:34:16.367687\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"transactionType\":\"SALE\",\n \"orderId\":\"order-123\",\n \"processorTransactionId\":\"pi_3L3edsGZasdasdc1iget38p\",\n \"processorName\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORasvasdNWFwi8c\",\n \"processorStatus\":\"SETTLED\",\n \"cardTokenType\":\"CARD_PAN\"\n }\n ],\n \"riskData\":{\n \"fraudChecks\":{\n \"source\":\"riskified\",\n \"preAuthorizationResult\":\"THREE_DS\",\n \"postAuthorizationResult\":\"ACCEPT\"\n },\n \"cvvCheck\": {\n \"source\": \"processor\",\n \"result\": \"MATCHED\"\n },\n \"avsCheck\": {\n \"source\": \"processor\",\n \"result\": {\n \"streetAddress\": \"NOT_MATCHED\",\n \"postalCode\": \"NOT_VERIFIED\"\n }\n }\n }\n }\n}\n```\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentStatusWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "date": "2023-01-01T00:00:00Z", + "notificationConfig": { + "id": "string", + "description": "string" + }, + "version": "string", + "payment": { + "id": "string", + "date": "2023-01-01T00:00:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 0, + "customerId": "string", + "metadata": { + "string": {} + }, + "paymentMethod": { + "descriptor": "string", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "string", + "vaultedPaymentMethodToken": "string", + "analyticsId": "string", + "paymentMethodType": "string", + "paymentMethodData": { + "first6Digits": "string", + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "cardholderName": "string", + "network": "string", + "isNetworkTokenized": true, + "binData": { + "network": "string", + "issuerCountryCode": "AW", + "issuerName": "string", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE", + "reasonText": "string", + "protocolVersion": "string", + "challengeIssued": true + } + }, + "processor": { + "name": "string", + "processorMerchantId": "string", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + }, + "transactions": [ + { + "processorMerchantId": "string", + "transactionType": "SALE", + "processorTransactionId": "string", + "processorName": "string", + "processorStatus": "PENDING", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + } + } + ], + "riskData": { + "fraudChecks": { + "source": "string", + "preAuthorizationResult": "ACCEPT", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "string", + "result": "MATCHED" + }, + "avsCheck": { + "source": "string", + "result": { + "streetAddress": "MATCHED", + "postalCode": "MATCHED" + } + } + } + } + } + } + ] + }, + "subpackage_paymentWebhooks.payment_refund_webhook_event": { + "id": "subpackage_paymentWebhooks.payment_refund_webhook_event", + "namespace": [ + "subpackage_paymentWebhooks" + ], + "description": "Primer notifies you with a `PAYMENT.REFUND` Webhook when a refund request has been fully processed by a payment processor and the refund has reached a final state.\n\nCheck the transaction with the most recent `transactionType: \"REFUND\"` in the `transactions` array:\n- if `processorStatus` is `SETTLED`, the refund was successful and the funds have been returned to the customer\n- if `processorStatus` is `FAILED`, the refund was unsuccessful\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentRefundWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "date": "2023-01-01T00:00:00Z", + "notificationConfig": { + "id": "string", + "description": "string" + }, + "version": "string", + "payment": { + "id": "string", + "date": "2023-01-01T00:00:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 0, + "customerId": "string", + "metadata": { + "string": {} + }, + "paymentMethod": { + "descriptor": "string", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "string", + "vaultedPaymentMethodToken": "string", + "analyticsId": "string", + "paymentMethodType": "string", + "paymentMethodData": { + "first6Digits": "string", + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "cardholderName": "string", + "network": "string", + "isNetworkTokenized": true, + "binData": { + "network": "string", + "issuerCountryCode": "AW", + "issuerName": "string", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE", + "reasonText": "string", + "protocolVersion": "string", + "challengeIssued": true + } + }, + "processor": { + "name": "string", + "processorMerchantId": "string", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + }, + "transactions": [ + { + "processorMerchantId": "string", + "transactionType": "SALE", + "processorTransactionId": "string", + "processorName": "string", + "processorStatus": "PENDING", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + } + } + ], + "riskData": { + "fraudChecks": { + "source": "string", + "preAuthorizationResult": "ACCEPT", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "string", + "result": "MATCHED" + }, + "avsCheck": { + "source": "string", + "result": { + "streetAddress": "MATCHED", + "postalCode": "MATCHED" + } + } + } + } + } + } + ] + }, + "subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event": { + "id": "subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event", + "namespace": [ + "subpackage_disputeChargebacksWebhooks" + ], + "description": "Primer notifies you with a `DISPUTE.OPEN` webhook on newly opened disputes or chargebacks. This notification is unified across all processors.\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DisputeOpenWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "processorId": "string", + "processorDisputeId": "string", + "paymentId": "string", + "transactionId": "string", + "orderId": "string", + "primerAccountId": "string" + } + } + ] + }, + "subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event": { + "id": "subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event", + "namespace": [ + "subpackage_disputeChargebacksWebhooks" + ], + "description": "Primer notifies you with a `DISPUTE.STATUS` webhook that will provide information on retrievals, disputes (also known as chargebacks), and preabritration filings.\n\nThis notification is supported for processors Adyen, Braintree, Checkout.com & PayPal.\n\nThe `DISPUTE.STATUS` event can be used to proactively communicate with customers, issue refunds, send disputes to risk tools, or to proactively defend disputes.\n\nThe `DISPUTE.STATUS` event is currently in an open beta stage, as we continue to add more processors.\n\nLearn more about [managing disputes at Primer](https://primer.io/docs/accept-payments/manage-disputes).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "version": "string", + "type": "RETRIEVAL", + "status": "OPEN", + "primerAccountId": "string", + "transactionId": "string", + "orderId": "string", + "paymentId": "string", + "paymentMethod": { + "paymentMethodType": "string", + "paymentMethodData": { + "network": "string" + } + }, + "processor": "ADYEN", + "processorDisputeId": "string", + "receivedAt": "2023-01-01T00:00:00Z", + "challengeRequiredBy": "2023-01-01T00:00:00Z", + "reason": "string", + "reasonCode": "string", + "processorReason": "string", + "amount": 0, + "currency": "string", + "merchantId": "string" + } + } + ] + } + }, + "types": { + "type_:AccountFundingTypeEnum": { + "name": "AccountFundingTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT" + }, + { + "value": "DEBIT" + }, + { + "value": "PREPAID" + }, + { + "value": "CHARGE" + }, + { + "value": "DEFERRED_DEBIT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ApayaCustomerTokenApiSchema": { + "name": "ApayaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mx", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mnc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "mcc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BinDataApiSchema": { + "name": "BinDataApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuerCurrencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + } + }, + { + "key": "regionalRestriction", + "valueShape": { + "type": "id", + "id": "type_:CardRegionRestrictionEnum" + } + }, + { + "key": "accountNumberType", + "valueShape": { + "type": "id", + "id": "type_:CardAccountNumberTypeEnum" + } + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + { + "key": "prepaidReloadableIndicator", + "valueShape": { + "type": "id", + "id": "type_:PrepaidReloadableEnum" + } + }, + { + "key": "productUsageType", + "valueShape": { + "type": "id", + "id": "type_:CardProductTypeEnum" + } + }, + { + "key": "productCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "productName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:CardAccountNumberTypeEnum": { + "name": "CardAccountNumberTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PRIMARY_ACCOUNT_NUMBER" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardNetworkEnum": { + "name": "CardNetworkEnum", + "description": "[The list of available card networks and their `CARD_NETWORK_TYPE` can be found here.](https://www.notion.so/primerio/Payment-Method-Types-2b971a8c54c3452cae0b2fffe9167d72)", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:CardProductTypeEnum": { + "name": "CardProductTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CONSUMER" + }, + { + "value": "BUSINESS" + }, + { + "value": "GOVERNMENT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardRegionRestrictionEnum": { + "name": "CardRegionRestrictionEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DOMESTIC_USE_ONLY" + }, + { + "value": "NONE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData": { + "name": "PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Order Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalOrderTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Payment Session Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaPaymentSessionApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Ideal Pay Nl Token Api Schema", + "shape": { + "type": "id", + "id": "type_:IdealPayNlTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchema": { + "name": "PaymentResponsePaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment method token used to authorize the transaction." + }, + { + "key": "vaultedPaymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If the payment method token was vaulted, this is the new token. Use this token for recurring payments." + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type" + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchema" + } + } + } + ] + } + }, + "type_:CountryCodeEnum": { + "name": "CountryCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:Currency": { + "name": "Currency", + "description": "Enumerates all supported currencies", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentResponseProcessorApiSchema": { + "name": "PaymentResponseProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + }, + { + "key": "amountCaptured", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no capture was performed, this value will be set to `0`.\n\nIf one or more partial captures were performed, this value will be a sum\nof all partial capture amounts." + }, + { + "key": "amountRefunded", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no refund was performed, this value will be set to `0`.\n\nIf one or more partial refunds were performed, this value will be a sum\nof all partial refund amounts." + } + ] + } + }, + "type_:GoCardlessMandateApiSchema": { + "name": "GoCardlessMandateApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gocardlessMandateId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of a GoCardless mandate agreement" + } + ] + } + }, + "type_:IdealPayNlTokenApiSchema": { + "name": "IdealPayNlTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodConfigId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:KlarnaAddressApiSchema": { + "name": "KlarnaAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "phoneNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine3", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:KlarnaCustomerTokenApiSchema": { + "name": "KlarnaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaCustomerToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaPaymentSessionApiSchema": { + "name": "KlarnaPaymentSessionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaAuthorizationToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaSessionDetailsApiSchema": { + "name": "KlarnaSessionDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "recurringDescription", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "billingAddress", + "valueShape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + } + }, + { + "key": "purchaseCountry", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "purchaseCurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "locale", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "orderLines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "key": "tokenDetails", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaTokenDetails" + } + } + } + ] + } + }, + "type_:KlarnaTokenDetails": { + "name": "KlarnaTokenDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "masked_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiry_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalBillingAgreementApiSchema": { + "name": "PayPalBillingAgreementApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalBillingAgreementId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddressApiSchema" + } + }, + "description": "The PayPal customer's shipping address" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalExternalPayerInfoApiSchema": { + "name": "PayPalExternalPayerInfoApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalPayerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalOrderTokenApiSchema": { + "name": "PayPalOrderTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalOrderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentStatusWebhookPayloadNotificationConfig": { + "name": "PaymentStatusWebhookPayloadNotificationConfig", + "description": "The notification configuration details.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration ID." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration description." + } + ] + } + }, + "type_:PaymentStatusWebhookPayloadPayment": { + "name": "PaymentStatusWebhookPayloadPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream operations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + }, + { + "key": "riskData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskDataApiSchema" + } + } + } + ] + } + }, + "type_:PaymentStatusWebhookPayload": { + "name": "PaymentStatusWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `PAYMENT.STATUS` in this case." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date-time that the webhook was sent." + }, + { + "key": "notificationConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatusWebhookPayloadNotificationConfig" + } + }, + "description": "The notification configuration details." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "payment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatusWebhookPayloadPayment" + } + } + } + ] + } + }, + "type_:PaymentRefundWebhookPayloadNotificationConfig": { + "name": "PaymentRefundWebhookPayloadNotificationConfig", + "description": "The notification configuration details.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration ID." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration description." + } + ] + } + }, + "type_:PaymentRefundWebhookPayloadPayment": { + "name": "PaymentRefundWebhookPayloadPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream operations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + }, + { + "key": "riskData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskDataApiSchema" + } + } + } + ] + } + }, + "type_:PaymentRefundWebhookPayload": { + "name": "PaymentRefundWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `PAYMENT.REFUND` in this case." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date-time that the webhook was sent." + }, + { + "key": "notificationConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRefundWebhookPayloadNotificationConfig" + } + }, + "description": "The notification configuration details." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "payment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRefundWebhookPayloadPayment" + } + } + } + ] + } + }, + "type_:DisputeOpenWebhookPayload": { + "name": "DisputeOpenWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `DISPUTE.OPEN` in this case." + }, + { + "key": "processorId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the processor that generated the dispute." + }, + { + "key": "processorDisputeId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the corresponding connection dispute." + }, + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer payment corresponding to this dispute." + }, + { + "key": "transactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer transaction corresponding to this dispute." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the sale transaction that the dispute relates to." + }, + { + "key": "primerAccountId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your Primer merchant account." + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadType": { + "name": "DisputeStatusWebhookPayloadType", + "description": "The type of dispute event. More information on what the `type` field represents can be found in [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes)", + "shape": { + "type": "enum", + "values": [ + { + "value": "RETRIEVAL" + }, + { + "value": "DISPUTE" + }, + { + "value": "PREARBITRATION" + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadStatus": { + "name": "DisputeStatusWebhookPayloadStatus", + "description": "To see which statuses are applicable for a dispute `type`, and how we map `status`, please see [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes).", + "shape": { + "type": "enum", + "values": [ + { + "value": "OPEN" + }, + { + "value": "ACCEPTED" + }, + { + "value": "CHALLENGED" + }, + { + "value": "EXPIRED" + }, + { + "value": "CANCELLED" + }, + { + "value": "WON" + }, + { + "value": "LOST" + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData": { + "name": "DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadPaymentMethod": { + "name": "DisputeStatusWebhookPayloadPaymentMethod", + "description": "The payment method information for the payment that is now disputed.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + } + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData" + } + } + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadProcessor": { + "name": "DisputeStatusWebhookPayloadProcessor", + "description": "The payment processor that you submitted a payment to, and received a dispute notification from.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ADYEN" + }, + { + "value": "BRAINTREE" + } + ] + } + }, + "type_:DisputeStatusWebhookPayload": { + "name": "DisputeStatusWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of event that triggered the webhook. This will have the value `DISPUTE.STATUS`. This indicates that a dispute notification was issued through a configured connection.\n\nUse these notifications to proactively communicate with your customer, issue refunds, or submit evidence to challenge disputes." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadType" + } + }, + "description": "The type of dispute event. More information on what the `type` field represents can be found in [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes)" + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadStatus" + } + }, + "description": "To see which statuses are applicable for a dispute `type`, and how we map `status`, please see [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes)." + }, + { + "key": "primerAccountId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your Primer merchant account." + }, + { + "key": "transactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer transaction corresponding to this dispute." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the sale transaction that the dispute relates to." + }, + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer payment corresponding to this dispute." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadPaymentMethod" + } + }, + "description": "The payment method information for the payment that is now disputed." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadProcessor" + } + }, + "description": "The payment processor that you submitted a payment to, and received a dispute notification from." + }, + { + "key": "processorDisputeId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier for this dispute provided by the processor. This is shared across multiple dispute `type` and `status` relating to the same payment.\n\ne.g. as an `open` dispute that is later challenged will share a `proccessorDisputeId`." + }, + { + "key": "receivedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date and time at which Primer received the processor's dispute event. Provided as an ISO timestamp in UTC." + }, + { + "key": "challengeRequiredBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Time by which the merchant must challenge a dispute. This is provided by the processor, where available." + }, + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Primer’s unified reason that explains why the dispute was raised. This should not vary across processors for the same dispute `reasonCode`, unlike the `processorReason`." + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The dispute reason code for a dispute. This will be the same code provided by the card schemes." + }, + { + "key": "processorReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The dispute reason provided by the processor. This can vary across processors for the same dispute `reasonCode`, which is why we provide a unified field - `reason`." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The disputed amount. Note: this is not always the same as the payment amount.\n\nThis will be displayed in minor units.\n\ne.g. for $7, use `700`. Some currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`." + }, + { + "key": "currency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "merchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this dispute." + } + ] + } + }, + "type_:PaymentCardTokenApiSchema": { + "name": "PaymentCardTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "isNetworkTokenized", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BinDataApiSchema" + } + } + } + ] + } + }, + "type_:StatusReasonApiSchema": { + "name": "StatusReasonApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatusTypeEnum" + }, + "description": "Type of the status." + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeclineTypeEnum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED` this will be returned.\n\nDeclines of type `SOFT_DECLINE` may be retried,\nwhereas declines of type `HARD_DECLINE` should not be retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionDeclineReasonV2Enum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED`, this will be returned." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "In case of an error on the processor's part, we will return the message returned by the processor. This is usually a human readable error." + } + ] + } + }, + "type_:RiskDataApiSchema": { + "name": "RiskDataApiSchema", + "description": "Risk data associated with this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fraudChecks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudCheckApiSchema" + } + } + }, + { + "key": "cvvCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CvvCheckApiSchema" + } + } + }, + { + "key": "avsCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsCheckApiSchema" + } + } + } + ] + } + }, + "type_:FraudCheckApiSchema": { + "name": "FraudCheckApiSchema", + "description": "Results of the pre-authorization and post-authorization fraud checks.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "preAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + }, + { + "key": "postAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + } + ] + } + }, + "type_:FraudDecisionTypeEnum": { + "name": "FraudDecisionTypeEnum", + "description": "Possible fraud check outcomes.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ACCEPT" + }, + { + "value": "REFUSE" + }, + { + "value": "FAILED" + }, + { + "value": "THREE_DS" + } + ] + } + }, + "type_:CvvCheckApiSchema": { + "name": "CvvCheckApiSchema", + "description": "Results of any external CVV check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:AvsCheckApiSchema": { + "name": "AvsCheckApiSchema", + "description": "Results of any external AVS check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsRiskAssessmentValues" + } + } + } + ] + } + }, + "type_:AvsRiskAssessmentValues": { + "name": "AvsRiskAssessmentValues", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "streetAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:RiskAssessmentStatusEnum": { + "name": "RiskAssessmentStatusEnum", + "description": "Possible risk assessment values for CVV and AVS checks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MATCHED" + }, + { + "value": "NOT_MATCHED" + }, + { + "value": "NOT_VERIFIED" + }, + { + "value": "NOT_PROVIDED" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "SKIPPED" + } + ] + } + }, + "type_:PaymentMethodTypeEnum": { + "name": "PaymentMethodTypeEnum", + "description": "[The list of available payment methods and their `PAYMENT_METHOD_TYPE` can be found here.](https://www.notion.so/primerio/Payment-Method-Types-2b971a8c54c3452cae0b2fffe9167d72)", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:PrepaidReloadableEnum": { + "name": "PrepaidReloadableEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RELOADABLE" + }, + { + "value": "NON_RELOADABLE" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ThreeDSecureAuthResponseCodeEnum": { + "name": "ThreeDSecureAuthResponseCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchemaReasonCode": { + "name": "ThreeDSecureAuthenticationApiSchemaReasonCode", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Three D Secure Skipped Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureSkippedReasonCodeEnum" + } + }, + { + "displayName": "Three D Secure Failed Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureFailedReasonCodeEnum" + } + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchema": { + "name": "ThreeDSecureAuthenticationApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "responseCode", + "valueShape": { + "type": "id", + "id": "type_:ThreeDSecureAuthResponseCodeEnum" + } + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchemaReasonCode" + } + } + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ThreeDSecureFailedReasonCodeEnum": { + "name": "ThreeDSecureFailedReasonCodeEnum", + "description": "This enum is derived from the `transStatusReason` on page 218 of the\n[EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/uploads/documents/EMVCo_3DS_Spec_v220_122018.pdf)\n\n| Code | Description |\n| ---- | --------------------------------------- |\n| 01 | Card authentication failed |\n| 02 | Unknown Device |\n| 03 | Unsupported Device |\n| 04 | Exceeds authentication frequency limit |\n| 05 | Expired card |\n| 06 | Invalid card number |\n| 07 | Invalid transaction |\n| 08 | No Card record |\n| 09 | Security failure |\n| 10 | Stolen card |\n| 11 | Suspected fraud |\n| 12 | Transaction not permitted to cardholder |\n| 13 | Cardholder not enrolled in service |\n| 14 | Transaction timed out at the ACS |\n| 15 | Low confidence |\n| 16 | Medium confidence |", + "shape": { + "type": "enum", + "values": [ + { + "value": "UNKNOWN" + }, + { + "value": "REJECTED_BY_ISSUER" + }, + { + "value": "CARD_AUTHENTICATION_FAILED" + }, + { + "value": "UNKNOWN_DEVICE" + }, + { + "value": "UNSUPPORTED_DEVICE" + }, + { + "value": "EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "INVALID_TRANSACTION" + }, + { + "value": "NO_CARD_RECORD" + }, + { + "value": "SECURITY_FAILURE" + }, + { + "value": "STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER" + }, + { + "value": "CARDHOLDER_NOT_ENROLLED_IN_SERVICE" + }, + { + "value": "TRANSACTION_TIMED_OUT_AT_THE_ACS" + }, + { + "value": "LOW_CONFIDENCE" + }, + { + "value": "MEDIUM_CONFIDENCE" + }, + { + "value": "HIGH_CONFIDENCE" + }, + { + "value": "VERY_HIGH_CONFIDENCE" + }, + { + "value": "EXCEEDS_ACS_MAXIMUM_CHALLENGES" + }, + { + "value": "NON_PAYMENT_NOT_SUPPORTED" + }, + { + "value": "THREE_RI_NOT_SUPPORTED" + }, + { + "value": "ACS_TECHNICAL_ISSUE" + }, + { + "value": "DECOUPLED_REQUIRED_BY_ACS" + }, + { + "value": "DECOUPLED_MAX_EXPIRY_EXCEEDED" + }, + { + "value": "DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME" + }, + { + "value": "AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER" + }, + { + "value": "ACS_TIMED_OUT" + }, + { + "value": "INVALID_ACS_RESPONSE" + }, + { + "value": "ACS_SYSTEM_ERROR_RESPONSE" + }, + { + "value": "ERROR_GENERATING_CAVV" + }, + { + "value": "PROTOCOL_VERSION_NOT_SUPPORTED" + }, + { + "value": "TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING" + }, + { + "value": "REQUESTED_PROGRAM_NOT_SUPPORTED" + } + ] + } + }, + "type_:ThreeDSecureSkippedReasonCodeEnum": { + "name": "ThreeDSecureSkippedReasonCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "GATEWAY_UNAVAILABLE" + }, + { + "value": "DISABLED_BY_MERCHANT" + }, + { + "value": "NOT_SUPPORTED_BY_ISSUER" + }, + { + "value": "FAILED_TO_NEGOTIATE" + }, + { + "value": "UNKNOWN_ACS_RESPONSE" + }, + { + "value": "3DS_SERVER_ERROR" + }, + { + "value": "ACQUIRER_NOT_CONFIGURED" + }, + { + "value": "ACQUIRER_NOT_PARTICIPATING" + } + ] + } + }, + "type_:DeclineTypeEnum": { + "name": "DeclineTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:TransactionDeclineReasonV2Enum": { + "name": "TransactionDeclineReasonV2Enum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:TransactionOverviewApiSchema": { + "name": "TransactionOverviewApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "transactionType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionTypeEnum" + } + } + }, + { + "key": "processorTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Processor's unique identifier for the transaction" + }, + { + "key": "processorName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier of a processor." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Processor's main account identifier.\n\n- Adyen: Account code\n- Braintree: Merchant ID\n- Stripe: Account ID\"" + }, + { + "key": "processorStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Transaction status, please refer to the [Transaction Status Codes](#section/API-Usage-Guide/Payment-Status) table for more information" + }, + { + "key": "processorStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "If the transaction has a declined or failed status.\n\nOnly if the status is `DECLINED` or `FAILED`, otherwise `null`." + } + ] + } + }, + "type_:PaymentStatus": { + "name": "PaymentStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "FAILED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "SETTLED" + }, + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + } + ] + } + }, + "type_:PaymentStatusTypeEnum": { + "name": "PaymentStatusTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:TransactionTypeEnum": { + "name": "TransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SALE" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:AddressApiSchema": { + "name": "AddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "id", + "id": "type_:CountryCodeEnum" + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:RecurringTransactionTypeEnum": { + "name": "RecurringTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + } + ] + } + }, + "type_:RecurringPaymentTypeSchema": { + "name": "RecurringPaymentTypeSchema", + "description": "Payment types, primarily to be used for recurring payments.\nNote: If you successfully vault a `SINGLE_USE` token on payment creation, then there's no need to set a value for this field and it will be flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all possible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RecurringTransactionTypeEnum" + } + } + }, + "type_:AuthorizationTypeEnum": { + "name": "AuthorizationTypeEnum", + "description": "Type of authorization for the payment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ESTIMATED" + }, + { + "value": "FINAL" + } + ] + } + }, + "type_:OptionalAddressApiSchema": { + "name": "OptionalAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:CheckoutCustomerDetailsApiSchema": { + "name": "CheckoutCustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.
Must be a valid email address. Supports internationalized email addresses." + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer billing address." + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + } + }, + "subpackages": { + "subpackage_paymentWebhooks": { + "id": "subpackage_paymentWebhooks", + "name": "paymentWebhooks" + }, + "subpackage_disputeChargebacksWebhooks": { + "id": "subpackage_disputeChargebacksWebhooks", + "name": "disputeChargebacksWebhooks" + } + }, + "auths": {} + }, + { + "id": "090e0b31-c453-4f41-8269-845a6e8a461f", + "endpoints": { + "subpackage_clientSessionApi.retrieveClientSideToken": { + "id": "subpackage_clientSessionApi.retrieveClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "This API call retrieves all the details associated with the client session corresponding to the client token that is provided in the request. The fields with empty values are excluded from the response.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token corresponding to the client session to retrieve" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "clientToken": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -d clientToken=string", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "clientToken": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -d clientToken=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_clientSessionApi.createClientSideToken": { + "id": "subpackage_clientSessionApi.createClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "Creating a client session generates a client token: a temporary key used to initialize [Universal Checkout](https://primer.io/docs/accept-payments/setup-universal-checkout/installation/web) and authenticate it against your account.\n\nUniversal Checkout automatically retrieves all the settings from the client session and the Dashboard to configure the payment methods and the checkout experience.\n\nNote:\nWhen creating a Client Session, please make sure to provide `currencyCode`, `orderId`, and at least one of `amount` or `lineItems`.\nIf any of these are not yet available, you can provide them w\nhen making the payment request.\n\nPOST /client-session does not have required fields as all fields are not always known when a client session is created.\nUse PATCH /client-session to update the parameters throughout the checkout session.\n\nClient tokens expire after 24 hours.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nCreate a client session token with a `customerId` to enable the client-side SDK to retrieve and manage your customer's saved payment methods. A client session token also enables saving payment methods against this customer id." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionWithTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + }, + "warnings": { + "type": "TAXJAR", + "code": "MISSING_DATA" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"currencyCode\": \"AED\",\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\",\n \"productData\": {}\n }\n ],\n \"countryCode\": \"AW\",\n \"retailerCountryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"orderedAllowedCardNetworks\": [\n \"AMEX\"\n ],\n \"options\": {\n \"\": {\n \"surcharge\": {}\n },\n \"PAYMENT_CARD\": {\n \"networks\": {\n \"AMEX\": {\n \"surcharge\": {}\n },\n \"DANKORT\": {\n \"surcharge\": {}\n },\n \"DINERS_CLUB\": {\n \"surcharge\": {}\n },\n \"DISCOVER\": {\n \"surcharge\": {}\n },\n \"ENROUTE\": {\n \"surcharge\": {}\n },\n \"ELO\": {\n \"surcharge\": {}\n },\n \"HIPER\": {\n \"surcharge\": {}\n },\n \"INTERAC\": {\n \"surcharge\": {}\n },\n \"JCB\": {\n \"surcharge\": {}\n },\n \"MAESTRO\": {\n \"surcharge\": {}\n },\n \"MASTERCARD\": {\n \"surcharge\": {}\n },\n \"MIR\": {\n \"surcharge\": {}\n },\n \"PRIVATE_LABEL\": {\n \"surcharge\": {}\n },\n \"UNIONPAY\": {\n \"surcharge\": {}\n },\n \"VISA\": {\n \"surcharge\": {}\n },\n \"OTHER\": {\n \"surcharge\": {}\n }\n }\n }\n },\n \"authorizationType\": \"ESTIMATED\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_clientSessionApi.updateClientSideToken": { + "id": "subpackage_clientSessionApi.updateClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "You can update a clients session created earlier with the `PATCH /client-session` [API call](#operation/create_client_side_token_client_session_post).\n\nThe only required field for the request is `clientToken`. Other supported request fields are same as for the `POST /client-session` [API call](#operation/create_client_side_token_client_session_post).\n\nYou need to specify only the fields you wish to update. However, if the items that are to be updated are of type `array`, then you need to provide the complete array along with modified items.\n\nIf you wish to update nested fields on the client session, such as the customer `emailAddress` field, you can pass the `customer` object with only one field, `emailAddress`, to update.\n\nIf you simply wish to clear the value of the field, pass `null` as your input.\n\nYou can update `paymentMethod.vaultOnSuccess` field but updating of the `paymentMethod.options` field through `PATCH /client-session` is not supported.\n\nThe response will contain all the fields of the client session including the ones that were changed.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token for use in the Primer-JS SDK obtained via `POST` /client-session API call." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the order." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "\nThe 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nProvide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method. Provide the entire object to update it. Anything provided previously will be overwritten." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\",\n \"productData\": {}\n }\n ],\n \"countryCode\": \"AW\",\n \"retailerCountryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"orderedAllowedCardNetworks\": [\n \"AMEX\"\n ],\n \"options\": {\n \"\": {\n \"surcharge\": {}\n },\n \"PAYMENT_CARD\": {\n \"networks\": {\n \"AMEX\": {\n \"surcharge\": {}\n },\n \"DANKORT\": {\n \"surcharge\": {}\n },\n \"DINERS_CLUB\": {\n \"surcharge\": {}\n },\n \"DISCOVER\": {\n \"surcharge\": {}\n },\n \"ENROUTE\": {\n \"surcharge\": {}\n },\n \"ELO\": {\n \"surcharge\": {}\n },\n \"HIPER\": {\n \"surcharge\": {}\n },\n \"INTERAC\": {\n \"surcharge\": {}\n },\n \"JCB\": {\n \"surcharge\": {}\n },\n \"MAESTRO\": {\n \"surcharge\": {}\n },\n \"MASTERCARD\": {\n \"surcharge\": {}\n },\n \"MIR\": {\n \"surcharge\": {}\n },\n \"PRIVATE_LABEL\": {\n \"surcharge\": {}\n },\n \"UNIONPAY\": {\n \"surcharge\": {}\n },\n \"VISA\": {\n \"surcharge\": {}\n },\n \"OTHER\": {\n \"surcharge\": {}\n }\n }\n }\n },\n \"authorizationType\": \"ESTIMATED\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.listPayments": { + "id": "subpackage_paymentsApi.listPayments", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a list of your payments.\n\nResults are paginated, they will only return up to 100 payments maximum.\nTo access the next page of result, set the `cursor` query parameter to the value of `nextCursor` in\nyour current result payload. Use `prevCursor` to go back to the previous page.\n\n**Note:** this endpoint returns a list of\nsummarized payments. Not all payments attributes are present. You can use\nthe query parameters to filter payments. You can separate multiple query parameters with the `&` symbol.\nQuery parameters with types of the form \"Array of strings\" (such as the status parameter) can be specified as a comma-separated list.\n\nFor example, if you wanted to get both `FAILED` and `CANCELLED` payments, for customer `john-123`, you would use:\n\n```bash\ncurl --location --request GET 'https://api.primer.io/payments?status=FAILED,CANCELLED&customer_id=john-123' \\\n--header 'X-Api-Key: '\n```\n\nYou can alternatively specify a list by repeating the parameter multiple times.\n\n**Note:** payments will be available within a minute from being created.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Filter payments by their status." + }, + { + "key": "payment_method_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Filter payments by their payment method type." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment processor." + }, + { + "key": "currency_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment currency.\ne.g. use `USD` for US dollars." + }, + { + "key": "from_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments from this date (inclusive)." + }, + { + "key": "to_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments up to this date (inclusive)." + }, + { + "key": "order_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Return payments related to this order ID." + }, + { + "key": "min_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount minimum (inclusive)." + }, + { + "key": "max_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount max (inclusive)." + }, + { + "key": "customer_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the customer that has made the payment." + }, + { + "key": "merchant_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the merchant involved in the payment." + }, + { + "key": "customer_email_address", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Email of the customer that has made the payment." + }, + { + "key": "last_4_digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Last 4 digits of the card used for the payment." + }, + { + "key": "paypal_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Paypal email address associated with the payment." + }, + { + "key": "klarna_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Klarna email address associated with the payment." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of payments to return per page." + }, + { + "key": "cursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If results are paginated, pass the `nextCursor` to access next page." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentListApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "string", + "date": "2024-01-15T09:30:00Z", + "dateUpdated": "2024-01-15T09:30:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 1, + "processor": { + "name": "string" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.createPayment": { + "id": "subpackage_paymentsApi.createPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nCreate and authorize a payment for a given customer order. You\nshould provide a payment method token here to avoid PCI implications.\n\nIf only a payment method token is passed, the values passed with the Client Session is used to determine the amount, currency etc.\nNote: `amount`, `currencyCode` and `orderId` are required during payment creation. Make sure to pass these fields when creating a client session, or if not yet available, when creating a payment.\n\nAll fields provided on this request will take preference over any field on the `order` associated with the client session. E.g. if you pass `amount` on this request, it will override the `amount` on the `order` associated with the Client Session.\nParameters that are not on this request will be fetched from previously created Client Session and merged. E.g. if you specify `customer.billingAddress` in Client Session and then pass `customer.emailAddress` data with this request, it will automatically merge the `customer` fields and use both `billingAddress` and `emailAddress` for later calculations.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`. The minimum amount is 0." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment method token used to authorize the payment.\n" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nThis attribute is required if `paymentMethod.vaultOnSuccess` is set to `True`." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n" + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequestPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string", + "currencyCode": "AED", + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "authorizationType": "ESTIMATED" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\",\n \"currencyCode\": \"AED\",\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\",\n \"productData\": {}\n }\n ],\n \"countryCode\": \"AW\",\n \"retailerCountryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"authorizationType\": \"ESTIMATED\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.authorizePayment": { + "id": "subpackage_paymentsApi.authorizePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nManually authorize a payment using a provided processor. This is useful if you want to authorize a payment without a workflow action.\nThe processor merchant ID must be provided which can be found on the [Integrations page](https://dashboard.primer.io/integrations).\nThe processor name is optional but it must be provided if your account has multiple processors configured which share the same merchant IDs.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/authorize" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the payment to authorize." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "processor", + "valueShape": { + "type": "id", + "id": "type_:PaymentAuthorizationRequestProcessorApiSchema" + }, + "description": "The payment processor to use for this payment." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_four_ErrorResponse" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_nine_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/authorize", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "acct_myprocessor_1234" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "MYPROCESSOR", + "processorMerchantId": "acct_myprocessor_1234", + "amountCaptured": 42, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_myprocessor_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "MYPROCESSOR", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/authorize \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"acct_myprocessor_1234\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 409, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.capturePayment": { + "id": "subpackage_paymentsApi.capturePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nIf you have successfully authorized a payment, you can now\nfully capture, or partially capture funds from the authorized payment, depending\non whether your selected payment processor supports it. The payment will\nbe updated to `SETTLED` or `SETTLING`, depending on the payment method type.\n\nThe payload sent in this capture request is completely optional. If you don't\nsend a payload with the capture request, the full amount that was authorized\nwill be sent for capture. Below are the available payload attributes, which\ngive you more granular control when capturing funds, if you require it.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/capture" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the payment to capture." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to capture, in minor units. The currency used on authorization is assumed.\n\nIf no amount is specified it defaults to the full amount." + }, + { + "key": "final", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether the capture request is the final capture request.\n\nAfter a final capture, no subsequent captures are allowed." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_paymentsApi:PaymentCaptureApiRequestOrder" + } + }, + "description": "More information associated with the order." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional payment metadata.\nThis only takes effect if the payment was created via the New Workflows ([read more here](https://primer.io/docs/changelog/migration-guides/new-workflows)).\nA dictionary of key-value pairs where the values can only be strings or integers. Keys which already exist in the payment metadata will be overwritten." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/capture", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "order": { + "retailerCountryCode": "AW" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "SETTLED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 42, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/capture \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"order\": {\n \"retailerCountryCode\": \"AW\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.cancelPayment": { + "id": "subpackage_paymentsApi.cancelPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nProvided the payment has not reached `SETTLED` status, Primer will\nsend a \"void\" request to the payment processor, thereby cancelling the payment\nand releasing the hold on customer funds. Upon success, the payment will transition\nto `CANCELLED`. The payload is optional.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/cancel" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to cancel." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the cancellation. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/cancel", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "CANCELLED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "CANCELLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/cancel \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/cancel", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/cancel \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.refundPayment": { + "id": "subpackage_paymentsApi.refundPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nBy default, this request will refund the full amount.\n\nOptionally, pass in a lesser amount for a partial refund.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/refund" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to refund." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to refund the customer, in minor units. e.g. for $7, use `700`.\n\nDefaults to remaining non-refunded amount." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optionally you can pass a specific order ID for the refund.\n\nBy default this will be set to the original `orderId` given on payment creation." + }, + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the refund. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/refund", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "SETTLED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 42, + "amountRefunded": 42 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/refund \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.resumePayment": { + "id": "subpackage_paymentsApi.resumePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nResume a payment's workflow execution from a paused state. This\nis usually required when a Workflow was paused in order to get further information\nfrom the customer, or when waiting for an asynchronous response from a third\nparty connection.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/resume" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to resume." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "resumeToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A token containing any information that is sent back from the checkout to complete a blocked payment flow." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/resume", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/resume", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.adjustAuthorization": { + "id": "subpackage_paymentsApi.adjustAuthorization", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nAdjust authorized amount. This is only possible if `authorizationType` was set to\n`ESTIMATED` when the payment was created, and the mechanism is supported by the payment method.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/adjust-authorization" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment for adjusting authorization." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The **final** amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_four_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/adjust-authorization", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "amount": 1 + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "ESTIMATED" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/adjust-authorization \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 1\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/adjust-authorization", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "amount": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/adjust-authorization \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/adjust-authorization", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "amount": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/adjust-authorization \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/adjust-authorization", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "amount": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/adjust-authorization \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 0\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.getPaymentById": { + "id": "subpackage_paymentsApi.getPaymentById", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a payment by its ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to retrieve." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "ACCEPT", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "MATCHED", + "postalCode": "MATCHED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post": { + "id": "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "

\n\nSave a `SINGLE_USE` payment method token so it can be used\nagain later.\n\nIf you try to vault an already vaulted token, you will get the existing vaulted token back.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + }, + { + "type": "literal", + "value": "/vault" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Payment method token to store." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID representing the customer" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/vault", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "paymentMethodType": "PAYMENT_CARD" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/vault", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/vault", + "responseStatusCode": 422, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get": { + "id": "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Retrieve a list of stored payment methods for a customer.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payment-instruments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "customer_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Return payment methods for this customer ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenListApiResponse" + } + } + }, + "examples": [ + { + "path": "/payment-instruments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "customer_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "paymentMethodType": "PAYMENT_CARD" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payment-instruments \\\n -H \"X-API-KEY: \" \\\n -d customer_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete": { + "id": "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Delete a saved payment method.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to delete." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "paymentMethodType": "PAYMENT_CARD" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post": { + "id": "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Update a saved payment method to be the default stored payment method for a customer.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + }, + { + "type": "literal", + "value": "/default" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to set to default." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/default", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/default", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_observabilityApiBeta.external_payment": { + "id": "subpackage_observabilityApiBeta.external_payment", + "namespace": [ + "subpackage_observabilityApiBeta" + ], + "description": "The Observability API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreating a payment with the Observability API sends external payments data to Primer to populate [Observability Payment Insights dashboards](https://primer.io/observability). Payments created through the [Payments API](/reference/create_payment_payments_post) will be automatically populated and do not need to be sent in the Observability API.\n\nCreate an API key with the `observability-payments:write` scope.\n\nEach record must be created with a unique `paymentId`. To update a payment record with new data use the `PATCH` endpoint.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/observability/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentsInsightsPayment" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentsInsightsPayment" + } + } + }, + "examples": [ + { + "path": "/observability/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paymentId": "string", + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "amount": 1, + "createdAt": "2024-01-15T09:30:00Z", + "order": { + "id": "string", + "countryCode": "AW" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentId": "string", + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "amount": 1, + "createdAt": "2024-01-15T09:30:00Z", + "order": { + "id": "string", + "countryCode": "AW" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/observability/payments \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentId\": \"string\",\n \"currencyCode\": \"AED\",\n \"processor\": {\n \"name\": \"APAYA\"\n },\n \"amount\": 1,\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"order\": {\n \"id\": \"string\",\n \"countryCode\": \"AW\"\n },\n \"paymentMethod\": {\n \"paymentMethodType\": \"PAYMENT_CARD\",\n \"data\": {\n \"binData\": {\n \"network\": \"AMEX\",\n \"issuerCountryCode\": \"AW\"\n }\n },\n \"threeDSecureAuthentication\": {\n \"responseCode\": \"NOT_PERFORMED\"\n }\n },\n \"status\": \"DECLINED\",\n \"statusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n },\n \"paymentType\": \"FIRST_PAYMENT\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_observabilityApiBeta.external_payment_update": { + "id": "subpackage_observabilityApiBeta.external_payment_update", + "namespace": [ + "subpackage_observabilityApiBeta" + ], + "description": "The Observability API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nYou can update payments created earlier through the Observability API with this endpoint. The only required field for the request is `paymentId`. Other supported request fields are the same as for the [create an external payment](/reference/external_payment) API call.\n\nIf you wish to update nested fields on the payment, you only need to pass the fields that you wish to update. For example to update the processor name, you would pass in `processor.name` only.\n\nThe response will contain all the fields of the payment including the ones that were changed.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/observability/payments/" + }, + { + "type": "pathParameter", + "value": "paymentId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment ID.\n\nThe payment ID must be unique. You can use this unique payment ID to update payment details." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode" + } + }, + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsProcessor" + } + } + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer,\nin minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units.\nIn this case you should use the value as it is, without any formatting.\nFor example for ¥100, use `100`.\nThe minimum amount is 0." + }, + { + "key": "createdAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The payment creation date and time (UTC) in [ISO 8601 format](\nhttps://en.wikipedia.org/wiki/ISO_8601).\n\nCannot be updated in partial updates PATCH." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsOrder" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus" + } + }, + "description": "See the payment [status table](\nhttps://apiref.primer.io/docs#payment-status) for more information." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReason" + } + }, + "description": "Pass more information regarding the payment's status in this field.\n\nThis is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentMethod" + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nAd dictionary of key-value pairs where the values can only be strings or integers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"88278a\"}`" + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType" + } + }, + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n\n| paymentType | Use case |\n| --- | --- |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |" + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment,\nas it would typically appear on a bank statement." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentsInsightsPayment" + } + } + }, + "examples": [ + { + "path": "/observability/payments/string", + "responseStatusCode": 200, + "pathParameters": { + "paymentId": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "order": { + "id": "string", + "countryCode": "AW" + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentId": "string", + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "amount": 1, + "createdAt": "2024-01-15T09:30:00Z", + "order": { + "id": "string", + "countryCode": "AW" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/observability/payments/string \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"currencyCode\": \"AED\",\n \"processor\": {\n \"name\": \"APAYA\"\n },\n \"order\": {\n \"id\": \"string\",\n \"countryCode\": \"AW\"\n },\n \"status\": \"DECLINED\",\n \"statusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n },\n \"paymentMethod\": {\n \"paymentMethodType\": \"PAYMENT_CARD\",\n \"data\": {\n \"binData\": {\n \"network\": \"AMEX\",\n \"issuerCountryCode\": \"AW\"\n }\n },\n \"threeDSecureAuthentication\": {\n \"responseCode\": \"NOT_PERFORMED\"\n }\n },\n \"paymentType\": \"FIRST_PAYMENT\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_loyaltyApi.get_loyalty_customer": { + "id": "subpackage_loyaltyApi.get_loyalty_customer", + "namespace": [ + "subpackage_loyaltyApi" + ], + "description": "The Loyalty API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreate an API key with the `loyalty-transactions:read` scopes.\n\nGet a loyalty customer by ID and connection ID. This includes the customer's points balance.\n\nThe `connectionId` is the unique Primer identifier for your loyalty provider connection. Primer will provide this once the loyalty provider connection is created.\n\nThe `customerId` refers to the customer identifier on the loyalty provider's side.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/loyalty-customers/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + } + ], + "queryParameters": [ + { + "key": "connectionId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Primer connection configuration." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LoyaltyApiBalanceResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/loyalty-customers/string", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": { + "connectionId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-customers/string \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-customers/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "connectionId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-customers/:id \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_loyaltyApi.get_loyalty_customer_transactions": { + "id": "subpackage_loyaltyApi.get_loyalty_customer_transactions", + "namespace": [ + "subpackage_loyaltyApi" + ], + "description": "The Loyalty API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreate an API key with the `loyalty-transactions:read` scopes.\n\nGet all your loyalty transactions. You can filter by `connectionId` (recommended) and by `customerId` and `orderId`.\n\nAdditionally provide a `limit` to restrict the number of transactions in the response, and an `offset` to determine where to start.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/loyalty-transactions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "connectionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter transactions by customer Id." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter transactions by customer Id." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter transactions by orderId." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Limit the number of returned results" + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of items to skip before returning results" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LoyaltyApiTransactionsListResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/loyalty-transactions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "items": [ + { + "date": "2023-01-01T12:00:00.00000", + "id": "t101", + "connectionId": "waon-123", + "customerId": "waon-customer-123", + "orderId": "order-123", + "connectionTransactionId": "waonTx1", + "connectionName": "WOAN", + "type": "REDEMPTION", + "value": 200 + } + ], + "total": 54, + "limit": 2, + "offset": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "connectionId": "string", + "customerId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string \\\n -d customerId=string", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "connectionId": "string", + "customerId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string \\\n -d customerId=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_loyaltyApi.post_loyalty_transaction": { + "id": "subpackage_loyaltyApi.post_loyalty_transaction", + "namespace": [ + "subpackage_loyaltyApi" + ], + "description": "The Loyalty API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreate an API key with the `loyalty-transactions:write` scopes.\n\nCreate a loyalty transaction. This is either a points redemption or a points refund.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/loyalty-transactions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "connectionId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Primer connection configuration." + }, + { + "key": "customerId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + }, + { + "key": "orderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the order." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LoyaltyTransactionTypeEnum" + } + }, + "description": "The type of the transaction." + }, + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The value of points to redeem." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LoyaltyApiTransactionResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/loyalty-transactions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connectionId": "string", + "customerId": "string", + "orderId": "string", + "value": 1, + "type": "REDEMPTION" + } + }, + "responseBody": { + "type": "json", + "value": { + "date": "2023-01-01", + "id": "t101", + "connectionId": "waon-123", + "customerId": "waon-customer-123", + "orderId": "order-123", + "connectionTransactionId": "waonTx1", + "connectionName": "WOAN", + "type": "REDEMPTION", + "value": 200 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connectionId\": \"string\",\n \"customerId\": \"string\",\n \"orderId\": \"string\",\n \"value\": 1,\n \"type\": \"REDEMPTION\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connectionId": "string", + "customerId": "string", + "orderId": "string", + "value": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connectionId\": \"string\",\n \"customerId\": \"string\",\n \"orderId\": \"string\",\n \"value\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connectionId": "string", + "customerId": "string", + "orderId": "string", + "value": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connectionId\": \"string\",\n \"customerId\": \"string\",\n \"orderId\": \"string\",\n \"value\": 0\n}'", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_paymentsApi:PaymentCaptureApiRequestOrder": { + "name": "PaymentCaptureApiRequestOrder", + "description": "More information associated with the order.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "retailerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country code of the retailer.\nThis field is passed to the processor and overwrites the retailer country code set in order details." + } + ] + } + }, + "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode": { + "name": "PaymentsInsightsPatchedPaymentCurrencyCode", + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus": { + "name": "PaymentsInsightsPatchedPaymentStatus", + "description": "See the payment [status table](https://apiref.primer.io/docs#payment-status) for more information.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + }, + { + "value": "FAILED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLED" + }, + { + "value": "PENDING" + } + ] + } + }, + "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType": { + "name": "PaymentsInsightsPatchedPaymentPaymentType", + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + }, + { + "value": "MOTO" + }, + { + "value": "IN_STORE" + } + ] + } + }, + "type_:AccountFundingTypeEnum": { + "name": "AccountFundingTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT" + }, + { + "value": "DEBIT" + }, + { + "value": "PREPAID" + }, + { + "value": "CHARGE" + }, + { + "value": "DEFERRED_DEBIT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ApayaCustomerTokenApiSchema": { + "name": "ApayaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mx", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mnc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "mcc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BinDataApiSchema": { + "name": "BinDataApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuerCurrencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + } + }, + { + "key": "regionalRestriction", + "valueShape": { + "type": "id", + "id": "type_:CardRegionRestrictionEnum" + } + }, + { + "key": "accountNumberType", + "valueShape": { + "type": "id", + "id": "type_:CardAccountNumberTypeEnum" + } + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + { + "key": "prepaidReloadableIndicator", + "valueShape": { + "type": "id", + "id": "type_:PrepaidReloadableEnum" + } + }, + { + "key": "productUsageType", + "valueShape": { + "type": "id", + "id": "type_:CardProductTypeEnum" + } + }, + { + "key": "productCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "productName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:BlockingPaymentActionTypeEnum": { + "name": "BlockingPaymentActionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "3DS_AUTHENTICATION" + }, + { + "value": "USE_PRIMER_SDK" + }, + { + "value": "PAYMENT_METHOD_VOUCHER" + }, + { + "value": "PROCESSOR_3DS" + } + ] + } + }, + "type_:CardAccountNumberTypeEnum": { + "name": "CardAccountNumberTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PRIMARY_ACCOUNT_NUMBER" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardNetworkEnum": { + "name": "CardNetworkEnum", + "description": "The list of available card networks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AMEX" + }, + { + "value": "DANKORT" + }, + { + "value": "DINERS_CLUB" + }, + { + "value": "DISCOVER" + }, + { + "value": "ENROUTE" + }, + { + "value": "ELO" + }, + { + "value": "HIPER" + }, + { + "value": "INTERAC" + }, + { + "value": "JCB" + }, + { + "value": "MAESTRO" + }, + { + "value": "MASTERCARD" + }, + { + "value": "MIR" + }, + { + "value": "PRIVATE_LABEL" + }, + { + "value": "UNIONPAY" + }, + { + "value": "VISA" + }, + { + "value": "OTHER" + } + ] + } + }, + "type_:CardProductTypeEnum": { + "name": "CardProductTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CONSUMER" + }, + { + "value": "BUSINESS" + }, + { + "value": "GOVERNMENT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardRegionRestrictionEnum": { + "name": "CardRegionRestrictionEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DOMESTIC_USE_ONLY" + }, + { + "value": "NONE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:OrderDetailsApiSchema": { + "name": "OrderDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "lineItems", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderLineItemsApiSchema" + } + } + }, + "description": "The details of the line items of the order." + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country in which the order is created" + }, + { + "key": "retailerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country code of the retailer" + }, + { + "key": "fees", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderFeesApiSchema" + } + } + }, + "description": "The details of fees charged." + }, + { + "key": "shipping", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderShippingApiSchema" + } + }, + "description": "The details of shipping charged." + } + ] + } + }, + "type_:OrderFeesApiSchema": { + "name": "OrderFeesApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The fee amount charged to the customer, in minor units. e.g. for $7, use `700`." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of fee." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the fee, e.g. \"Currency Conversion Fee\"." + } + ] + } + }, + "type_:OrderLineItemsApiSchema": { + "name": "OrderLineItemsApiSchema", + "description": "The details of the line items of the order.\n\nThe total amount of a line item is calculated like so:\n\n````\n totalAmount = (amount * quantity) - discountAmount + taxAmount\n```\n````", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "itemId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the line item." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A name of the item." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the item." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The amount charged to the customer, in minor units. The minimum amount is 0." + }, + { + "key": "quantity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of the particular line item that is being ordered." + }, + { + "key": "discountAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Any discount applicable to this item, in minor units. This discount is applied for the entire line item, and not per `quantity`." + }, + { + "key": "taxAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The tax charged on this item, in minor units. This tax amount is applied for the entire line item, and not per `quantity`." + }, + { + "key": "taxCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tax code associated with this item, in minor units. This is required for Primer-initiated tax calculations." + }, + { + "key": "productType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProductTypeEnum" + } + }, + "description": "An identifier for the product type." + }, + { + "key": "productData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderLineItemsProductDataApiSchema" + } + }, + "description": "Details related to the product" + } + ] + } + }, + "type_:OrderLineItemsProductDataApiSchema": { + "name": "OrderLineItemsProductDataApiSchema", + "description": "Details related to the product", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "sku", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product SKU" + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product brand" + }, + { + "key": "color", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product color" + }, + { + "key": "globalTradeItemNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product Global Trade Item Number (e.g. ISBN)" + }, + { + "key": "manufacturerPartNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product Manufacturer Part Number" + }, + { + "key": "weight", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The product weight" + }, + { + "key": "weightUnit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product weight unit (e.g. kg, g)" + } + ] + } + }, + "type_:OrderShippingApiSchema": { + "name": "OrderShippingApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The shipping amount charged to the customer, in minor units. e.g. for $7, use `700`." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchemaOptions": { + "name": "CheckoutPaymentMethodOptionsApiSchemaOptions", + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionApiSchema" + } + } + }, + { + "key": "PAYMENT_CARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodCardOptionApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchema": { + "name": "CheckoutPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "vaultOn3DS", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted after a successful 3DS authentication or not." + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "orderedAllowedCardNetworks", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + }, + "description": "If provided, the checkout will run the validation on the entered card number and raise an error in case the card network is not supported.\n\nThe order sets the default card network that should be used in the case of co-badged cards.\ne.g. in the case of `[\"VISA\", \"CARTES_BANCAIRES\", \"MASTERCARD\"]` - if the user enters a \"Visa\" / \"Cartes Bancaires\" card: the default is Visa.\n\nValues should be unique.\n\nIf `null` or nothing passed in the request, the following list with all card networks will be returned in the response:\n\n`[\"VISA\", \"MASTERCARD\", \"AMEX\", \"MAESTRO\", \"UNIONPAY\", \"CARTES_BANCAIRES\", \"DANKORT\", \"DINERS_CLUB\", \"DISCOVER\", \"ENROUTE\", \"ELO\", \"HIPER\", \"INTERAC\", \"JCB\", \"MIR\", \"OTHER\"]`" + }, + { + "key": "options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchemaOptions" + } + }, + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options." + }, + { + "key": "authorizationType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AuthorizationTypeEnum" + } + }, + "description": "Allows to adjust the authorized amount after the authorization, if supported by payment method.\n`FINAL` - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount.\n`ESTIMATED` - the amount can be adjusted after the authorization, if supported by payment method." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionApiSchema": { + "name": "CheckoutPaymentMethodOptionApiSchema", + "description": "Options for the payment method of type `PAYMENT_METHOD_TYPE`.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + }, + "description": "Surcharge information" + }, + { + "key": "extraMerchantData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionExtraMerchantDataApiSchema" + } + }, + "description": "For payments using the Klarna payment method, depending on the merchant segment and/or\nthe services available to consumers, Klarna may require additional information regarding\nthe customer, the merchant and/or the purchase. This information, referred to as extra merchant\ndata (EMD), consist of data that is typically not available at the checkout, but which enables\nKlarna to complete an assertive risk assessment, enable new promotional products and improve\nconversion rates for a boost in performance." + } + ] + } + }, + "type_:CheckoutPaymentMethodCardOptionApiSchema": { + "name": "CheckoutPaymentMethodCardOptionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "networks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema" + } + }, + "description": "Dictionary of available card networks as a key with value of Payment Method Card Network Option." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "AMEX", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DANKORT", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DINERS_CLUB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DISCOVER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ENROUTE", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ELO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "HIPER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "INTERAC", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "JCB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MAESTRO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MASTERCARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MIR", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "PRIVATE_LABEL", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "UNIONPAY", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "VISA", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "OTHER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + } + }, + "description": "Surcharge information" + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionExtraMerchantDataApiSchema": { + "name": "CheckoutPaymentMethodOptionExtraMerchantDataApiSchema", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "type_:PaymentRequestPaymentMethodOptionsApiSchema": { + "name": "PaymentRequestPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "vaultOn3DS", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted after a successful 3DS authentication or not." + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "authorizationType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AuthorizationTypeEnum" + } + }, + "description": "Allows to adjust the authorized amount after the authorization, if supported by payment method.\n`FINAL` - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount.\n`ESTIMATED` - the amount can be adjusted after the authorization, if supported by payment method.\nDefaults to `FINAL`." + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData": { + "name": "PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Order Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalOrderTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Payment Session Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaPaymentSessionApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Ideal Pay Nl Token Api Schema", + "shape": { + "type": "id", + "id": "type_:IdealPayNlTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchema": { + "name": "PaymentResponsePaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the payment, as it would typically appear\non a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment method token used to authorize the transaction." + }, + { + "key": "isVaulted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method token represents a vaulted payment method and can be used for future payments." + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type used for payment authorization." + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchema" + } + } + }, + { + "key": "authorizationType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AuthorizationTypeEnum" + } + }, + "description": "Allows to adjust the authorized amount after the authorization, if supported by payment method. `FINAL` - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount. `ESTIMATED` - the amount can be adjusted after the authorization, if supported by payment method." + } + ] + } + }, + "type_:CheckoutCustomerDetailsApiSchema": { + "name": "CheckoutCustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.
Must be a valid email address. Supports internationalized email addresses." + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer billing address." + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:CustomerDetailsApiSchema": { + "name": "CustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer billing address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:ClientSessionWithTokenApiResponse": { + "name": "ClientSessionWithTokenApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token used to initialize the SDK on all platforms." + }, + { + "key": "clientTokenExpirationDate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Expiration date & time of the client token (UTC with no timezoneinfo)." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment methods." + }, + { + "key": "warnings", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ClientSessionWarningsApiResponse" + } + }, + "description": "Warning messages to indicate missing information that are required for payment methods, checkout modules and other features; or when third-party services are unavailable." + } + ] + } + }, + "type_:ClientSessionApiResponse": { + "name": "ClientSessionApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you are going to charge the customer, in minor units. This amount is calculated from the line items, shipping and other amounts provided in the `order`.\nIf a top-level amount is provided, it would override any calculated amount." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment methods." + } + ] + } + }, + "type_:ClientSessionWarningsApiResponse": { + "name": "ClientSessionWarningsApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the connection involved" + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique code describing the particular issue" + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "More information as to the reason for the warning" + } + ] + } + }, + "type_:CountryCodeEnum": { + "name": "CountryCodeEnum", + "description": "2-letter country code in ISO 3166-1 alpha format,\ne.g. FR for France and GB for the United Kingdom.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:Currency": { + "name": "Currency", + "description": "3-letter currency code in ISO 4217 format,\ne.g. USD for US dollars.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentResponseProcessorApiSchema": { + "name": "PaymentResponseProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + }, + { + "key": "amountCaptured", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no capture was performed, this value will be set to `0`.\n\nIf one or more partial captures were performed, this value will be a sum\nof all partial capture amounts." + }, + { + "key": "amountRefunded", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no refund was performed, this value will be set to `0`.\n\nIf one or more partial refunds were performed, this value will be a sum\nof all partial refund amounts." + } + ] + } + }, + "type_:GoCardlessMandateApiSchema": { + "name": "GoCardlessMandateApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gocardlessMandateId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of a GoCardless mandate agreement" + } + ] + } + }, + "type_:IdealPayNlTokenApiSchema": { + "name": "IdealPayNlTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodConfigId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:KlarnaAddressApiSchema": { + "name": "KlarnaAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "phoneNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine3", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:KlarnaCustomerTokenApiSchema": { + "name": "KlarnaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaCustomerToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaPaymentSessionApiSchema": { + "name": "KlarnaPaymentSessionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaAuthorizationToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaSessionDetailsApiSchema": { + "name": "KlarnaSessionDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "recurringDescription", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "billingAddress", + "valueShape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + } + }, + { + "key": "purchaseCountry", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "purchaseCurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "locale", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "orderLines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "key": "tokenDetails", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaTokenDetails" + } + } + } + ] + } + }, + "type_:KlarnaTokenDetails": { + "name": "KlarnaTokenDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "masked_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiry_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalBillingAgreementApiSchema": { + "name": "PayPalBillingAgreementApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalBillingAgreementId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddressApiSchema" + } + }, + "description": "The PayPal customer's shipping address" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalExternalPayerInfoApiSchema": { + "name": "PayPalExternalPayerInfoApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalPayerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalOrderTokenApiSchema": { + "name": "PayPalOrderTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalOrderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentApiResponse": { + "name": "PaymentApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "dateUpdated", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time of the last payment update in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "cardTokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardTokenTypeEnum" + } + }, + "description": "The type of card token used for the payment.\n\nOnly applies for card payments." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "requiredAction", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequiredActionApiSchema" + } + }, + "description": "Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\n\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + }, + { + "key": "riskData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskDataApiSchema" + } + } + } + ] + } + }, + "type_:PaymentCardTokenApiSchema": { + "name": "PaymentCardTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "isNetworkTokenized", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BinDataApiSchema" + } + } + } + ] + } + }, + "type_:StatusReasonApiSchema": { + "name": "StatusReasonApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatusTypeEnum" + }, + "description": "Type of the status." + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeclineTypeEnum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED` this will be returned.\n\nDeclines of type `SOFT_DECLINE` may be retried,\nwhereas declines of type `HARD_DECLINE` should not be retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionDeclineReasonV2Enum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED`, this will be returned." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "In case of an error on the processor's part, we will return the message returned by the processor. This is usually a human readable error." + } + ] + } + }, + "type_:RiskDataApiSchema": { + "name": "RiskDataApiSchema", + "description": "Risk data associated with this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fraudChecks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudCheckApiSchema" + } + } + }, + { + "key": "cvvCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CvvCheckApiSchema" + } + } + }, + { + "key": "avsCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsCheckApiSchema" + } + } + } + ] + } + }, + "type_:FraudCheckApiSchema": { + "name": "FraudCheckApiSchema", + "description": "Results of the pre-authorization and post-authorization fraud checks.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "preAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + }, + { + "key": "postAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + } + ] + } + }, + "type_:FraudDecisionTypeEnum": { + "name": "FraudDecisionTypeEnum", + "description": "Possible fraud check outcomes.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ACCEPT" + }, + { + "value": "REFUSE" + }, + { + "value": "FAILED" + }, + { + "value": "THREE_DS" + } + ] + } + }, + "type_:CvvCheckApiSchema": { + "name": "CvvCheckApiSchema", + "description": "Results of any external CVV check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:AvsCheckApiSchema": { + "name": "AvsCheckApiSchema", + "description": "Results of any external AVS check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsRiskAssessmentValues" + } + } + } + ] + } + }, + "type_:AvsRiskAssessmentValues": { + "name": "AvsRiskAssessmentValues", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "streetAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:RiskAssessmentStatusEnum": { + "name": "RiskAssessmentStatusEnum", + "description": "Possible risk assessment values for CVV and AVS checks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MATCHED" + }, + { + "value": "NOT_MATCHED" + }, + { + "value": "NOT_VERIFIED" + }, + { + "value": "NOT_PROVIDED" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "SKIPPED" + } + ] + } + }, + "type_:PaymentMethodTypeEnum": { + "name": "PaymentMethodTypeEnum", + "description": "Payment method type, where `OFF_SESSION_PAYMENT` is used for APM (Alternative Payment Method) payments and `PAYMENT_CARD` for traditional debit or credit cards. Please note that this list is different from one indicated on [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) page and values of this field will be changed in the future versions of the API.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PAYMENT_CARD" + }, + { + "value": "PAYPAL_ORDER" + }, + { + "value": "PAYPAL_BILLING_AGREEMENT" + }, + { + "value": "GOCARDLESS_MANDATE" + }, + { + "value": "KLARNA_AUTHORIZATION_TOKEN" + }, + { + "value": "KLARNA_CUSTOMER_TOKEN" + }, + { + "value": "PAY_NL_IDEAL" + }, + { + "value": "APAYA" + }, + { + "value": "OFF_SESSION_PAYMENT" + }, + { + "value": "CARD_OFF_SESSION_PAYMENT" + }, + { + "value": "APPLE_PAY" + }, + { + "value": "APPLE_PAY_ENCRYPTED_TOKEN" + }, + { + "value": "GOOGLE_PAY" + } + ] + } + }, + "type_:PaymentListApiResponse": { + "name": "PaymentListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PaymentSummaryApiSchema" + } + } + } + }, + { + "key": "nextCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "prevCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentRequiredActionApiSchema": { + "name": "PaymentRequiredActionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:BlockingPaymentActionTypeEnum" + }, + "description": "Action name" + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Human description of the required action to perform." + }, + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The client token to be returned to the SDK if a required action is returned." + } + ] + } + }, + "type_:PaymentSummaryApiSchema": { + "name": "PaymentSummaryApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "dateUpdated", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The date and time of the last payment update in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatus" + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Your reference for the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentSummaryProcessorApiSchema" + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The payment amount, in minor units. e.g. $7 would show as `700`." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`" + } + ] + } + }, + "type_:PaymentAuthorizationRequestProcessorApiSchema": { + "name": "PaymentAuthorizationRequestProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The processor's merchant ID used to authorize the payment." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The processor name should be provided if the processorMerchantId is not unique across all of your integrations." + } + ] + } + }, + "type_:PaymentSummaryProcessorApiSchema": { + "name": "PaymentSummaryProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + } + ] + } + }, + "type_:PrepaidReloadableEnum": { + "name": "PrepaidReloadableEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RELOADABLE" + }, + { + "value": "NON_RELOADABLE" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:RecurringTransactionTypeEnum": { + "name": "RecurringTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + } + ] + } + }, + "type_:RecurringPaymentTypeSchema": { + "name": "RecurringPaymentTypeSchema", + "description": "Payment types, primarily to be used for recurring payments.\nNote: If you successfully vault a `SINGLE_USE` token on payment creation, then there's no need to set a value for this field and it will be flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all possible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RecurringTransactionTypeEnum" + } + } + }, + "type_:ProductTypeEnum": { + "name": "ProductTypeEnum", + "description": "An enumeration", + "shape": { + "type": "enum", + "values": [ + { + "value": "PHYSICAL" + }, + { + "value": "DIGITAL" + } + ] + } + }, + "type_:ThreeDSecureAuthResponseCodeEnum": { + "name": "ThreeDSecureAuthResponseCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchemaReasonCode": { + "name": "ThreeDSecureAuthenticationApiSchemaReasonCode", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Three D Secure Skipped Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureSkippedReasonCodeEnum" + } + }, + { + "displayName": "Three D Secure Failed Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureFailedReasonCodeEnum" + } + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchema": { + "name": "ThreeDSecureAuthenticationApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "responseCode", + "valueShape": { + "type": "id", + "id": "type_:ThreeDSecureAuthResponseCodeEnum" + } + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchemaReasonCode" + } + } + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ThreeDSecureFailedReasonCodeEnum": { + "name": "ThreeDSecureFailedReasonCodeEnum", + "description": "This enum is derived from the `transStatusReason` on page 218 of the\n[EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/uploads/documents/EMVCo_3DS_Spec_v220_122018.pdf)\n\n| Code | Description |\n| ---- | --------------------------------------- |\n| 01 | Card authentication failed |\n| 02 | Unknown Device |\n| 03 | Unsupported Device |\n| 04 | Exceeds authentication frequency limit |\n| 05 | Expired card |\n| 06 | Invalid card number |\n| 07 | Invalid transaction |\n| 08 | No Card record |\n| 09 | Security failure |\n| 10 | Stolen card |\n| 11 | Suspected fraud |\n| 12 | Transaction not permitted to cardholder |\n| 13 | Cardholder not enrolled in service |\n| 14 | Transaction timed out at the ACS |\n| 15 | Low confidence |\n| 16 | Medium confidence |", + "shape": { + "type": "enum", + "values": [ + { + "value": "UNKNOWN" + }, + { + "value": "REJECTED_BY_ISSUER" + }, + { + "value": "CARD_AUTHENTICATION_FAILED" + }, + { + "value": "UNKNOWN_DEVICE" + }, + { + "value": "UNSUPPORTED_DEVICE" + }, + { + "value": "EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "INVALID_TRANSACTION" + }, + { + "value": "NO_CARD_RECORD" + }, + { + "value": "SECURITY_FAILURE" + }, + { + "value": "STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER" + }, + { + "value": "CARDHOLDER_NOT_ENROLLED_IN_SERVICE" + }, + { + "value": "TRANSACTION_TIMED_OUT_AT_THE_ACS" + }, + { + "value": "LOW_CONFIDENCE" + }, + { + "value": "MEDIUM_CONFIDENCE" + }, + { + "value": "HIGH_CONFIDENCE" + }, + { + "value": "VERY_HIGH_CONFIDENCE" + }, + { + "value": "EXCEEDS_ACS_MAXIMUM_CHALLENGES" + }, + { + "value": "NON_PAYMENT_NOT_SUPPORTED" + }, + { + "value": "THREE_RI_NOT_SUPPORTED" + }, + { + "value": "ACS_TECHNICAL_ISSUE" + }, + { + "value": "DECOUPLED_REQUIRED_BY_ACS" + }, + { + "value": "DECOUPLED_MAX_EXPIRY_EXCEEDED" + }, + { + "value": "DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME" + }, + { + "value": "AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER" + }, + { + "value": "ACS_TIMED_OUT" + }, + { + "value": "INVALID_ACS_RESPONSE" + }, + { + "value": "ACS_SYSTEM_ERROR_RESPONSE" + }, + { + "value": "ERROR_GENERATING_CAVV" + }, + { + "value": "PROTOCOL_VERSION_NOT_SUPPORTED" + }, + { + "value": "TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING" + }, + { + "value": "REQUESTED_PROGRAM_NOT_SUPPORTED" + } + ] + } + }, + "type_:ThreeDSecureSkippedReasonCodeEnum": { + "name": "ThreeDSecureSkippedReasonCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "GATEWAY_UNAVAILABLE" + }, + { + "value": "DISABLED_BY_MERCHANT" + }, + { + "value": "NOT_SUPPORTED_BY_ISSUER" + }, + { + "value": "FAILED_TO_NEGOTIATE" + }, + { + "value": "UNKNOWN_ACS_RESPONSE" + }, + { + "value": "3DS_SERVER_ERROR" + }, + { + "value": "ACQUIRER_NOT_CONFIGURED" + }, + { + "value": "ACQUIRER_NOT_PARTICIPATING" + } + ] + } + }, + "type_:TokenTypeEnum": { + "name": "TokenTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MULTI_USE" + }, + { + "value": "SINGLE_USE" + } + ] + } + }, + "type_:DeclineTypeEnum": { + "name": "DeclineTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:TransactionDeclineReasonV2Enum": { + "name": "TransactionDeclineReasonV2Enum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:TransactionOverviewApiSchema": { + "name": "TransactionOverviewApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Date & time of the transaction (UTC)" + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Transaction amount in minor units" + }, + { + "key": "currencyCode", + "valueShape": { + "type": "id", + "id": "type_:Currency" + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "transactionType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionTypeEnum" + } + } + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The reference submitted on payment creation or refund." + }, + { + "key": "processorTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Processor's unique identifier for the transaction" + }, + { + "key": "processorName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier of a processor." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Processor's main account identifier.\n\n- Adyen: Account code\n- Braintree: Merchant ID\n- Stripe: Account ID\"" + }, + { + "key": "processorStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Transaction status, please refer to the [Transaction Status Codes](#section/API-Usage-Guide/Payment-Status) table for more information" + }, + { + "key": "processorStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "If the transaction has a declined or failed status.\n\nOnly if the status is `DECLINED` or `FAILED`, otherwise `null`." + }, + { + "key": "cardTokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardTokenTypeEnum" + } + }, + "description": "The type of card token used for the transaction.\n\nOnly applies for card payments." + } + ] + } + }, + "type_:PaymentStatus": { + "name": "PaymentStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "FAILED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "SETTLED" + }, + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + } + ] + } + }, + "type_:PaymentStatusTypeEnum": { + "name": "PaymentStatusTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:TransactionTypeEnum": { + "name": "TransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SALE" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:OptionalAddressApiSchema": { + "name": "OptionalAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:AddressApiSchema": { + "name": "AddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "id", + "id": "type_:CountryCodeEnum" + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData": { + "name": "MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponse": { + "name": "MerchantPaymentMethodTokenApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Creation date & time of the object (UTC)" + }, + { + "key": "deletedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date & time when this object was revoked. (UTC)" + }, + { + "key": "deleted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this object has been revoked." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The vaulted payment method token." + }, + { + "key": "tokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "- `MULTI_USE` a vaulted token that can be re-used with subsequent payments" + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type associated with a token." + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID representing the customer" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly description given by the user" + }, + { + "key": "default", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this payment method is the default" + } + ] + } + }, + "type_:VerifiedMerchantPaymentMethodTokenApiResponse": { + "name": "VerifiedMerchantPaymentMethodTokenApiResponse", + "shape": { + "type": "object", + "extends": [ + "type_:MerchantPaymentMethodTokenApiResponse" + ], + "properties": [ + { + "key": "isVerified", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this payment method was verified" + } + ] + } + }, + "type_:VerifiedMerchantPaymentMethodTokenListApiResponse": { + "name": "VerifiedMerchantPaymentMethodTokenListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + } + } + ] + } + }, + "type_:LoyaltyApiBalanceResponse": { + "name": "LoyaltyApiBalanceResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + }, + { + "key": "connectionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the Primer connection configuration." + }, + { + "key": "connectionName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the loyalty provider." + }, + { + "key": "balance", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The loyalty customer's points balance." + } + ] + } + }, + "type_:LoyaltyTransactionTypeEnum": { + "name": "LoyaltyTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "REDEMPTION" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:LoyaltyApiTransactionResponse": { + "name": "LoyaltyApiTransactionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Creation date & time of the transaction (UTC)" + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique Primer identifier for the loyalty transaction." + }, + { + "key": "connectionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the Primer connection configuration." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the order." + }, + { + "key": "connectionTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the transaction on the loyalty provider's side." + }, + { + "key": "connectionName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the loyalty provider." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LoyaltyTransactionTypeEnum" + } + }, + "description": "The type of the transaction." + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The value of the transaction." + } + ] + } + }, + "type_:LoyaltyApiTransactionsListResponse": { + "name": "LoyaltyApiTransactionsListResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LoyaltyApiTransactionResponse" + } + } + }, + "description": "The list of loyalty transactions" + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of available results" + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The limit of the paged result" + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The offset of the paged result" + } + ] + } + }, + "type_:PaymentsInsightsBinDataIssuerCountryCode": { + "name": "PaymentsInsightsBinDataIssuerCountryCode", + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:PaymentsInsightsBinData": { + "name": "PaymentsInsightsBinData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsBinDataIssuerCountryCode" + } + }, + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom." + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the issuing bank." + }, + { + "key": "productUsageType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The usage type of the payment card e.g. commercial, consumer." + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The funding type of the payment card e.g. credit, debit, prepaid." + } + ] + } + }, + "type_:PaymentsInsightsOrderCountryCode": { + "name": "PaymentsInsightsOrderCountryCode", + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:PaymentsInsightsOrder": { + "name": "PaymentsInsightsOrder", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The order reference for the payment." + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsOrderCountryCode" + } + }, + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom." + } + ] + } + }, + "type_:PaymentsInsightsPaymentCurrencyCode": { + "name": "PaymentsInsightsPaymentCurrencyCode", + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentsInsightsPaymentStatus": { + "name": "PaymentsInsightsPaymentStatus", + "description": "See the payment [status table](https://apiref.primer.io/docs#payment-status) for more information.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + }, + { + "value": "FAILED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLED" + }, + { + "value": "PENDING" + } + ] + } + }, + "type_:PaymentsInsightsPaymentPaymentType": { + "name": "PaymentsInsightsPaymentPaymentType", + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + }, + { + "value": "MOTO" + }, + { + "value": "IN_STORE" + } + ] + } + }, + "type_:PaymentsInsightsPayment": { + "name": "PaymentsInsightsPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment ID.\n\nThe payment ID must be unique. You can use this unique payment ID to update payment details." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentCurrencyCode" + }, + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars." + }, + { + "key": "processor", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsProcessor" + } + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The amount you would like to charge the customer,\nin minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units.\nIn this case you should use the value as it is, without any formatting.\nFor example for ¥100, use `100`.\nThe minimum amount is 0." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The payment creation date and time (UTC) in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).\n\nCannot be updated in partial updates PATCH." + }, + { + "key": "order", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsOrder" + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentStatus" + } + }, + "description": "See the payment [status table](https://apiref.primer.io/docs#payment-status) for more information." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReason" + } + }, + "description": "Pass more information regarding the payment's status in this field.\n\nThis is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentMethod" + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nAd dictionary of key-value pairs where the values can only be strings or integers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"88278a\"}`" + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentPaymentType" + } + }, + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |" + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment,\nas it would typically appear on a bank statement." + } + ] + } + }, + "type_:PaymentsInsightsPaymentMethod": { + "name": "PaymentsInsightsPaymentMethod", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodType", + "valueShape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + }, + "description": "Payment method type used for payment authorization." + }, + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentMethodData" + } + } + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsThreeDSecureAuthentication" + } + } + } + ] + } + }, + "type_:PaymentsInsightsPaymentMethodData": { + "name": "PaymentsInsightsPaymentMethodData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsBinData" + } + } + }, + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The first six digits of the card used for payment,\nalso known as the Bank Identification Number (BIN)." + } + ] + } + }, + "type_:PaymentsInsightsProcessorName": { + "name": "PaymentsInsightsProcessorName", + "description": "The payment processor used for this payment.\nPrimer supports the above processors through the Payments API,\nhowever any value can be passed here.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APAYA" + }, + { + "value": "ADYEN" + }, + { + "value": "AFTERPAY" + }, + { + "value": "AIRWALLEX" + }, + { + "value": "ALIANT" + }, + { + "value": "ALIPAY" + }, + { + "value": "ATOME" + }, + { + "value": "BANKED" + }, + { + "value": "BARCLAYCARD" + }, + { + "value": "BRAINTREE" + }, + { + "value": "BUCKAROO" + }, + { + "value": "BRIDGE" + }, + { + "value": "CHAI" + }, + { + "value": "CHECKOUT" + }, + { + "value": "CLEARPAY" + }, + { + "value": "COINBASE" + }, + { + "value": "CYBERSOURCE" + }, + { + "value": "DLOCAL" + }, + { + "value": "EBANX" + }, + { + "value": "ECOSPEND" + }, + { + "value": "FINTECTURE" + }, + { + "value": "GLOBAL_PAYMENTS" + }, + { + "value": "HOOLAH" + }, + { + "value": "INGENICO" + }, + { + "value": "INGENICO-CONNECT" + }, + { + "value": "KLARNA" + }, + { + "value": "LAYBUY" + }, + { + "value": "MPGS" + }, + { + "value": "MOLLIE" + }, + { + "value": "NEONOMICS" + }, + { + "value": "NEXI" + }, + { + "value": "NUVEI" + }, + { + "value": "OMISE" + }, + { + "value": "OPENNODE" + }, + { + "value": "PAY_NL" + }, + { + "value": "PAY-NL" + }, + { + "value": "PAYGENT" + }, + { + "value": "PAYPAL" + }, + { + "value": "PRIMER_TEST" + }, + { + "value": "STRIPE" + }, + { + "value": "TRILO" + }, + { + "value": "TRUELAYER" + }, + { + "value": "VOLT" + }, + { + "value": "VYNE" + }, + { + "value": "WORLDPAY" + }, + { + "value": "EMERCHANTPAY" + }, + { + "value": "XFERS" + }, + { + "value": "RAPYD" + }, + { + "value": "AUTHNET" + }, + { + "value": "NETS" + }, + { + "value": "NETAXEPT" + }, + { + "value": "PRIMER_PROCESSOR" + }, + { + "value": "REACH" + }, + { + "value": "TRUST_PAYMENTS" + }, + { + "value": "TWOC2P" + }, + { + "value": "MERCADO_PAGO" + }, + { + "value": "PAYU" + }, + { + "value": "XENDIT" + }, + { + "value": "FISERV" + }, + { + "value": "PACYPAY" + }, + { + "value": "SHOPEEPAY" + }, + { + "value": "TRIPLE_A" + }, + { + "value": "IPAY88" + }, + { + "value": "APPLE_PAY" + }, + { + "value": "GOOGLE_PAY" + }, + { + "value": "RISKIFIED" + }, + { + "value": "TAXJAR" + }, + { + "value": "STITCH" + }, + { + "value": "SIGNIFYD" + } + ] + } + }, + "type_:PaymentsInsightsProcessor": { + "name": "PaymentsInsightsProcessor", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsProcessorName" + }, + "description": "The payment processor used for this payment.\nPrimer supports the above processors through the Payments API,\nhowever any value can be passed here." + }, + { + "key": "merchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + } + ] + } + }, + "type_:PaymentsInsightsStatusReasonType": { + "name": "PaymentsInsightsStatusReasonType", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:PaymentsInsightsStatusReasonDeclineType": { + "name": "PaymentsInsightsStatusReasonDeclineType", + "description": "Declines of type `SOFT_DECLINE` may have been retried.\nWhereas declines of type `HARD_DECLINE` should have not been retried.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:PaymentsInsightsStatusReasonCode": { + "name": "PaymentsInsightsStatusReasonCode", + "description": "Payment status code with the error code when\nthe issuer declined the payment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:PaymentsInsightsStatusReason": { + "name": "PaymentsInsightsStatusReason", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReasonType" + } + } + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReasonDeclineType" + } + }, + "description": "Declines of type `SOFT_DECLINE` may have been retried.\nWhereas declines of type `HARD_DECLINE` should have not been retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReasonCode" + } + }, + "description": "Payment status code with the error code when\nthe issuer declined the payment." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message detail returned by the processor when\nthe error on appeared on their part." + } + ] + } + }, + "type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode": { + "name": "PaymentsInsightsThreeDSecureAuthenticationResponseCode", + "description": "The response returned during the 3D Secure authentication call.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:PaymentsInsightsThreeDSecureAuthentication": { + "name": "PaymentsInsightsThreeDSecureAuthentication", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "transStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "transStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "responseCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode" + } + }, + "description": "The response returned during the 3D Secure authentication call." + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "The challenge status of the 3D Secure authentication.\nSet to false for frictionless 3D Secure authentication." + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The protocol version used during 3D Secure authentication." + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The reason code for unsuccessful 3D Secure authentication attempts." + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The human readable reason text for unsuccessful\n3D Secure authentication attempts." + }, + { + "key": "eci", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "E-commerce Indicator (ECI)" + } + ] + } + }, + "type_:ErrorObject": { + "name": "ErrorObject", + "description": "An object containing information about the error that occurred.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "errorId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An error ID" + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A human readable description of the error" + }, + { + "key": "diagnosticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An ID that you can quote when contacting the Primer support team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11)." + }, + { + "key": "validationErrors", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "description": "Returned in case of a badly formed request" + } + ] + } + }, + "type_:four_hundred_ErrorResponse": { + "name": "four_hundred_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:ErrorObject" + } + } + ] + } + }, + "type_:four_hundred_four_ErrorResponse": { + "name": "four_hundred_four_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:ErrorObject" + } + } + ] + } + }, + "type_:four_hundred_nine_ErrorResponse": { + "name": "four_hundred_nine_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:ErrorObject" + } + } + ] + } + }, + "type_:four_hundred_twenty_two_ErrorResponse": { + "name": "four_hundred_twenty_two_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:ErrorObject" + } + } + ] + } + }, + "type_:AuthorizationTypeEnum": { + "name": "AuthorizationTypeEnum", + "description": "Type of authorization for the payment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ESTIMATED" + }, + { + "value": "FINAL" + } + ] + } + }, + "type_:CardTokenTypeEnum": { + "name": "CardTokenTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CARD_PAN" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "PROCESSOR_TOKEN" + } + ] + } + } + }, + "subpackages": { + "subpackage_clientSessionApi": { + "id": "subpackage_clientSessionApi", + "name": "Client Session API" + }, + "subpackage_paymentsApi": { + "id": "subpackage_paymentsApi", + "name": "Payments API" + }, + "subpackage_paymentMethodsApi": { + "id": "subpackage_paymentMethodsApi", + "name": "Payment Methods API" + }, + "subpackage_observabilityApiBeta": { + "id": "subpackage_observabilityApiBeta", + "name": "Observability API (beta)" + }, + "subpackage_loyaltyApi": { + "id": "subpackage_loyaltyApi", + "name": "Loyalty API" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-API-KEY", + "nameOverride": "apiKey" + } + } + }, + { + "id": "7ed504c0-fc2e-4a52-b3fd-b277869eda14", + "endpoints": { + "subpackage_clientSessionApi.retrieveClientSideToken": { + "id": "subpackage_clientSessionApi.retrieveClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "This API call retrieves all the details associated with the client session corresponding to the client token that is provided in the request. The fields with empty values are excluded from the response.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token corresponding to the client session to retrieve" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "clientToken": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -d clientToken=string", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "clientToken": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -d clientToken=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_clientSessionApi.createClientSideToken": { + "id": "subpackage_clientSessionApi.createClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "Creating a client session generates a client token: a temporary key used to initialize [Universal Checkout](https://primer.io/docs/accept-payments/setup-universal-checkout/installation/web) and authenticate it against your account.\n\nUniversal Checkout automatically retrieves all the settings from the client session and the Dashboard to configure the payment methods and the checkout experience.\n\nNote:\nWhen creating a Client Session, please make sure to provide `currencyCode`, `orderId`, and at least one of `amount` or `lineItems`.\nIf any of these are not yet available, you can provide them when making the payment request.\n\n`POST /client-session` does not have required fields as all fields are not always known when a client session is created.\nUse `PATCH /client-session` to update the parameters throughout the checkout session.\n\nClient tokens expire after 24 hours.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nCreate a client session token with a `customerId` to enable the client-side SDK to retrieve and manage your customer's saved payment methods. A client session token also enables saving payment methods against this customer id." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionWithTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + } + } + } + }, + "responseBody": { + "type": "json", + "value": { + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + } + }, + "warnings": { + "type": "TAXJAR", + "code": "MISSING_DATA" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\"\n }\n ],\n \"countryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"options\": {\n \"\": {\n \"surcharge\": {}\n },\n \"PAYMENT_CARD\": {\n \"networks\": {\n \"AMEX\": {\n \"surcharge\": {}\n },\n \"DANKORT\": {\n \"surcharge\": {}\n },\n \"DINERS_CLUB\": {\n \"surcharge\": {}\n },\n \"DISCOVER\": {\n \"surcharge\": {}\n },\n \"ENROUTE\": {\n \"surcharge\": {}\n },\n \"ELO\": {\n \"surcharge\": {}\n },\n \"HIPER\": {\n \"surcharge\": {}\n },\n \"INTERAC\": {\n \"surcharge\": {}\n },\n \"JCB\": {\n \"surcharge\": {}\n },\n \"MAESTRO\": {\n \"surcharge\": {}\n },\n \"MASTERCARD\": {\n \"surcharge\": {}\n },\n \"MIR\": {\n \"surcharge\": {}\n },\n \"PRIVATE_LABEL\": {\n \"surcharge\": {}\n },\n \"UNIONPAY\": {\n \"surcharge\": {}\n },\n \"VISA\": {\n \"surcharge\": {}\n },\n \"OTHER\": {\n \"surcharge\": {}\n }\n }\n }\n }\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_clientSessionApi.updateClientSideToken": { + "id": "subpackage_clientSessionApi.updateClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "You can update a clients session created earlier with the `PATCH /client-session` [API call](#operation/create_client_side_token_client_session_post).\n\nThe only required field for the request is `clientToken`. Other supported request fields are same as for the `POST /client-session` [API call](#operation/create_client_side_token_client_session_post).\n\nYou need to specify only the fields you wish to update. However, if the items that are to be updated are of type `array`, then you need to provide the complete array along with modified items.\n\nIf you wish to update nested fields on the client session, such as the customer `emailAddress` field, you can pass the `customer` object with only one field, `emailAddress`, to update.\n\nIf you simply wish to clear the value of the field, pass `null` as your input.\n\nYou can update `paymentMethod.vaultOnSuccess` field but updating of the `paymentMethod.options` field through `PATCH /client-session` is not supported.\n\nThe response will contain all the fields of the client session including the ones that were changed.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token for use in the Primer-JS SDK obtained via `POST` /client-session API call." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the order." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "\nThe 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nProvide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method. Provide the entire object to update it. Anything provided previously will be overwritten." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + } + } + } + }, + "responseBody": { + "type": "json", + "value": { + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\"\n }\n ],\n \"countryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"options\": {\n \"\": {\n \"surcharge\": {}\n },\n \"PAYMENT_CARD\": {\n \"networks\": {\n \"AMEX\": {\n \"surcharge\": {}\n },\n \"DANKORT\": {\n \"surcharge\": {}\n },\n \"DINERS_CLUB\": {\n \"surcharge\": {}\n },\n \"DISCOVER\": {\n \"surcharge\": {}\n },\n \"ENROUTE\": {\n \"surcharge\": {}\n },\n \"ELO\": {\n \"surcharge\": {}\n },\n \"HIPER\": {\n \"surcharge\": {}\n },\n \"INTERAC\": {\n \"surcharge\": {}\n },\n \"JCB\": {\n \"surcharge\": {}\n },\n \"MAESTRO\": {\n \"surcharge\": {}\n },\n \"MASTERCARD\": {\n \"surcharge\": {}\n },\n \"MIR\": {\n \"surcharge\": {}\n },\n \"PRIVATE_LABEL\": {\n \"surcharge\": {}\n },\n \"UNIONPAY\": {\n \"surcharge\": {}\n },\n \"VISA\": {\n \"surcharge\": {}\n },\n \"OTHER\": {\n \"surcharge\": {}\n }\n }\n }\n }\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.listPayments": { + "id": "subpackage_paymentsApi.listPayments", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a list of your payments.\n\nResults are paginated, they will only return up to 100 payments maximum.\nTo access the next page of result, set the `cursor` query parameter to the value of `nextCursor` in\nyour current result payload. Use `prevCursor` to go back to the previous page.\n\n**Note:** this endpoint returns a list of\nsummarized payments. Not all payments attributes are present. You can use\nthe query parameters to filter payments. You can separate multiple query parameters with the `&` symbol.\nQuery parameters with types of the form \"Array of strings\" (such as the status parameter) can be specified as a comma-separated list.\n\nFor example, if you wanted to get both `FAILED` and `CANCELLED` payments, for customer `john-123`, you would use:\n\n```bash\ncurl --location --request GET 'https://api.primer.io/payments?status=FAILED,CANCELLED&customer_id=john-123' \\\n--header 'X-Api-Key: '\n```\n\nYou can alternatively specify a list by repeating the parameter multiple times.\n\n**Note:** payments will be available within a minute from being created.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Filter payments by their status." + }, + { + "key": "payment_method_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Filter payments by their payment method type." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment processor." + }, + { + "key": "currency_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment currency.\ne.g. use `USD` for US dollars." + }, + { + "key": "from_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments from this date (inclusive)." + }, + { + "key": "to_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments up to this date (inclusive)." + }, + { + "key": "order_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Return payments related to this order ID." + }, + { + "key": "min_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount minimum (inclusive)." + }, + { + "key": "max_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount max (inclusive)." + }, + { + "key": "customer_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the customer that has made the payment." + }, + { + "key": "merchant_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the merchant involved in the payment." + }, + { + "key": "customer_email_address", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Email of the customer that has made the payment." + }, + { + "key": "last_4_digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Last 4 digits of the card used for the payment." + }, + { + "key": "paypal_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Paypal email address associated with the payment." + }, + { + "key": "klarna_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Klarna email address associated with the payment." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of payments to return per page." + }, + { + "key": "cursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If results are paginated, pass the `nextCursor` to access next page." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentListApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "string", + "date": "2024-01-15T09:30:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.createPayment": { + "id": "subpackage_paymentsApi.createPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nCreate and authorize a payment for a given customer order. You\nshould provide a payment method token here to avoid PCI implications.\n\nIf only a payment method token is passed, the values passed with the Client Session determine the amount, currency etc.\n\nNote: `amount`, `currencyCode` and `orderId` are required during payment creation. Make sure to pass these fields when creating a client session, or if not yet available, when creating a payment.\n\nAll fields provided on this request will take preference over any field on the `order` associated with the client session. E.g. if you pass `amount` on this request, it will override the `amount` on the `order` associated with the Client Session.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`. The minimum amount is 0." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment method token used to authorize the payment.\n" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nThis attribute is required if `paymentMethod.vaultOnSuccess` is set to `True`." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n" + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequestPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string", + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "AUTHORIZED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\",\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\"\n }\n ],\n \"countryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.capturePayment": { + "id": "subpackage_paymentsApi.capturePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nIf you have successfully authorized a payment, you can now\nfully capture, or partially capture funds from the authorized payment, depending\non whether your selected payment processor supports it. The payment will\nbe updated to `SETTLED` or `SETTLING`, depending on the payment method type.\n\nThe payload sent in this capture request is completely optional. If you don't\nsend a payload with the capture request, the full amount that was authorized\nwill be sent for capture. Below are the available payload attributes, which\ngive you more granular control when capturing funds, if you require it.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/capture" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the payment to capture." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to capture, in minor units. The currency used on authorization is assumed.\n\nIf no amount is specified it defaults to the full amount." + }, + { + "key": "final", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether the capture request is the final capture request.\n\nAfter a final capture, no subsequent captures are allowed." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional payment metadata.\nThis only takes effect if the payment was created via the New Workflows ([read more here](https://primer.io/docs/changelog/migration-guides/new-workflows)).\nA dictionary of key-value pairs where the values can only be strings or integers. Keys which already exist in the payment metadata will be overwritten." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/capture", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "SETTLED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 42, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/capture \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.cancelPayment": { + "id": "subpackage_paymentsApi.cancelPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nProvided the payment has not reached `SETTLED` status, Primer will\nsend a \"void\" request to the payment processor, thereby cancelling the payment\nand releasing the hold on customer funds. Upon success, the payment will transition\nto `CANCELLED`. The payload is optional.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/cancel" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to cancel." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the cancellation. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/cancel", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "CANCELLED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "CANCELLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/cancel \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/cancel", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/cancel \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.refundPayment": { + "id": "subpackage_paymentsApi.refundPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nBy default, this request will refund the full amount.\n\nOptionally, pass in a lesser amount for a partial refund.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/refund" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to refund." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to refund the customer, in minor units. e.g. for $7, use `700`.\n\nDefaults to remaining non-refunded amount." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optionally you can pass a specific order ID for the refund.\n\nBy default this will be set to the original `orderId` given on payment creation." + }, + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the refund. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/refund", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "SETTLED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 42, + "amountRefunded": 42 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/refund \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.resumePayment": { + "id": "subpackage_paymentsApi.resumePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nResume a payment's workflow execution from a paused state. This\nis usually required when a Workflow was paused in order to get further information\nfrom the customer, or when waiting for an asynchronous response from a third\nparty connection.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/resume" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to resume." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "resumeToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A token containing any information that is sent back from the checkout to complete a blocked payment flow." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/resume", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "AUTHORIZED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/resume", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.getPaymentById": { + "id": "subpackage_paymentsApi.getPaymentById", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a payment by its ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to retrieve." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "AUTHORIZED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL" + } + ], + "countryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "string", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post": { + "id": "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "

\n\nSave a `SINGLE_USE` payment method token so it can be used\nagain later.\n\nIf you try to vault an already vaulted token, you will get the existing vaulted token back.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + }, + { + "type": "literal", + "value": "/vault" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Payment method token to store." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID representing the customer" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/vault", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + }, + "paymentMethodType": "PAYMENT_CARD" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/vault", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "description": "string", + "errorId": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/vault", + "responseStatusCode": 422, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "description": "string", + "errorId": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get": { + "id": "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Retrieve a list of stored payment methods for a customer.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payment-instruments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "customer_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Return payment methods for this customer ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenListApiResponse" + } + } + }, + "examples": [ + { + "path": "/payment-instruments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "customer_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + }, + "paymentMethodType": "PAYMENT_CARD" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payment-instruments \\\n -H \"X-API-KEY: \" \\\n -d customer_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete": { + "id": "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Delete a saved payment method.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to delete." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + }, + "paymentMethodType": "PAYMENT_CARD" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "description": "string", + "errorId": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post": { + "id": "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Update a saved payment method to be the default stored payment method for a customer.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + }, + { + "type": "literal", + "value": "/default" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to set to default." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/default", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/default", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "description": "string", + "errorId": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:AccountFundingTypeEnum": { + "name": "AccountFundingTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT" + }, + { + "value": "DEBIT" + }, + { + "value": "PREPAID" + }, + { + "value": "CHARGE" + }, + { + "value": "DEFERRED_DEBIT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ApayaCustomerTokenApiSchema": { + "name": "ApayaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mx", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mnc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "mcc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BinDataOptionalApiSchema": { + "name": "BinDataOptionalApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + } + ] + } + }, + "type_:BinDataApiSchema": { + "name": "BinDataApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuerCurrencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + } + }, + { + "key": "regionalRestriction", + "valueShape": { + "type": "id", + "id": "type_:CardRegionRestrictionEnum" + } + }, + { + "key": "accountNumberType", + "valueShape": { + "type": "id", + "id": "type_:CardAccountNumberTypeEnum" + } + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + { + "key": "prepaidReloadableIndicator", + "valueShape": { + "type": "id", + "id": "type_:PrepaidReloadableEnum" + } + }, + { + "key": "productUsageType", + "valueShape": { + "type": "id", + "id": "type_:CardProductTypeEnum" + } + }, + { + "key": "productCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "productName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:BlockingPaymentActionTypeEnum": { + "name": "BlockingPaymentActionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "3DS_AUTHENTICATION" + }, + { + "value": "USE_PRIMER_SDK" + } + ] + } + }, + "type_:CardAccountNumberTypeEnum": { + "name": "CardAccountNumberTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PRIMARY_ACCOUNT_NUMBER" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardNetworkEnum": { + "name": "CardNetworkEnum", + "description": "The list of available card networks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AMEX" + }, + { + "value": "DANKORT" + }, + { + "value": "DINERS_CLUB" + }, + { + "value": "DISCOVER" + }, + { + "value": "ENROUTE" + }, + { + "value": "ELO" + }, + { + "value": "HIPER" + }, + { + "value": "INTERAC" + }, + { + "value": "JCB" + }, + { + "value": "MAESTRO" + }, + { + "value": "MASTERCARD" + }, + { + "value": "MIR" + }, + { + "value": "PRIVATE_LABEL" + }, + { + "value": "UNIONPAY" + }, + { + "value": "VISA" + }, + { + "value": "OTHER" + } + ] + } + }, + "type_:CardProductTypeEnum": { + "name": "CardProductTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CONSUMER" + }, + { + "value": "BUSINESS" + }, + { + "value": "GOVERNMENT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardRegionRestrictionEnum": { + "name": "CardRegionRestrictionEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DOMESTIC_USE_ONLY" + }, + { + "value": "NONE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:OrderDetailsApiSchema": { + "name": "OrderDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "lineItems", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderLineItemsApiSchema" + } + } + }, + "description": "The details of the line items of the order." + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country in which the order is created" + }, + { + "key": "fees", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderFeesApiSchema" + } + } + }, + "description": "The details of fees charged." + }, + { + "key": "shipping", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderShippingApiSchema" + } + }, + "description": "The details of shipping charged." + } + ] + } + }, + "type_:OrderFeesApiSchema": { + "name": "OrderFeesApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The fee amount charged to the customer, in minor units. e.g. for $7, use `700`." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of fee." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the fee, e.g. \"Currency Conversion Fee\"." + } + ] + } + }, + "type_:OrderLineItemsApiSchema": { + "name": "OrderLineItemsApiSchema", + "description": "The details of the line items of the order.\n\nThe total amount of a line item is calculated like so:\n\n````\n totalAmount = (amount * quantity) - discountAmount + taxAmount\n```\n````", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "itemId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the line item." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the item." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The amount charged to the customer, in minor units. The minimum amount is 0." + }, + { + "key": "quantity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of the particular line item that is being ordered." + }, + { + "key": "discountAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Any discount applicable to this item, in minor units. This discount is applied for the entire line item, and not per `quantity`." + }, + { + "key": "taxAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The tax charged on this item, in minor units. This tax amount is applied for the entire line item, and not per `quantity`." + }, + { + "key": "taxCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tax code associated with this item, in minor units. This is required for Primer-initiated tax calculations." + }, + { + "key": "productType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProductTypeEnum" + } + }, + "description": "An identifier for the product type." + } + ] + } + }, + "type_:OrderShippingApiSchema": { + "name": "OrderShippingApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The shipping amount charged to the customer, in minor units. e.g. for $7, use `700`." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchemaOptions": { + "name": "CheckoutPaymentMethodOptionsApiSchemaOptions", + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionApiSchema" + } + } + }, + { + "key": "PAYMENT_CARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodCardOptionApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchema": { + "name": "CheckoutPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchemaOptions" + } + }, + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionApiSchema": { + "name": "CheckoutPaymentMethodOptionApiSchema", + "description": "Options for the payment method of type `PAYMENT_METHOD_TYPE`.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + }, + "description": "Surcharge information" + } + ] + } + }, + "type_:CheckoutPaymentMethodCardOptionApiSchema": { + "name": "CheckoutPaymentMethodCardOptionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "networks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema" + } + }, + "description": "Dictionary of available card networks as a key with value of Payment Method Card Network Option." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "AMEX", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DANKORT", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DINERS_CLUB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DISCOVER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ENROUTE", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ELO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "HIPER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "INTERAC", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "JCB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MAESTRO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MASTERCARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MIR", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "PRIVATE_LABEL", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "UNIONPAY", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "VISA", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "OTHER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + } + }, + "description": "Surcharge information" + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated." + } + ] + } + }, + "type_:PaymentRequestPaymentMethodOptionsApiSchema": { + "name": "PaymentRequestPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData": { + "name": "PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Order Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalOrderTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Payment Session Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaPaymentSessionApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Ideal Pay Nl Token Api Schema", + "shape": { + "type": "id", + "id": "type_:IdealPayNlTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchema": { + "name": "PaymentResponsePaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment method token used to authorize the transaction." + }, + { + "key": "isVaulted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method token represents a vaulted payment method and can be used for future payments." + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type" + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutCustomerDetailsApiSchema": { + "name": "CheckoutCustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address." + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer billing address." + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:CustomerDetailsApiSchema": { + "name": "CustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer billing address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:ClientSessionWithTokenApiResponse": { + "name": "ClientSessionWithTokenApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token used to initialize the SDK on all platforms." + }, + { + "key": "clientTokenExpirationDate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Expiration date & time of the client token (UTC with no timezoneinfo)." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment methods." + }, + { + "key": "warnings", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ClientSessionWarningsApiResponse" + } + }, + "description": "Warning messages to indicate missing information that are required for payment methods, checkout modules and other features; or when third-party services are unavailable." + } + ] + } + }, + "type_:ClientSessionApiResponse": { + "name": "ClientSessionApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you are going to charge the customer, in minor units. This amount is calculated from the line items, shipping and other amounts provided in the `order`.\nIf a top-level amount is provided, it would override any calculated amount." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment methods." + } + ] + } + }, + "type_:ClientSessionWarningsApiResponse": { + "name": "ClientSessionWarningsApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the connection involved" + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique code describing the particular issue" + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "More information as to the reason for the warning" + } + ] + } + }, + "type_:CountryCodeEnum": { + "name": "CountryCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:Currency": { + "name": "Currency", + "description": "Enumerates all supported currencies", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentResponseProcessorApiSchema": { + "name": "PaymentResponseProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + }, + { + "key": "amountCaptured", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no capture was performed, this value will be set to `0`.\n\nIf one or more partial captures were performed, this value will be a sum\nof all partial capture amounts." + }, + { + "key": "amountRefunded", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no refund was performed, this value will be set to `0`.\n\nIf one or more partial refunds were performed, this value will be a sum\nof all partial refund amounts." + } + ] + } + }, + "type_:GoCardlessMandateApiSchema": { + "name": "GoCardlessMandateApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gocardlessMandateId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of a GoCardless mandate agreement" + } + ] + } + }, + "type_:IdealPayNlTokenApiSchema": { + "name": "IdealPayNlTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodConfigId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:KlarnaAddressApiSchema": { + "name": "KlarnaAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "phoneNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine3", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:KlarnaCustomerTokenApiSchema": { + "name": "KlarnaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaCustomerToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaPaymentSessionApiSchema": { + "name": "KlarnaPaymentSessionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaAuthorizationToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaSessionDetailsApiSchema": { + "name": "KlarnaSessionDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "recurringDescription", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "billingAddress", + "valueShape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + } + }, + { + "key": "purchaseCountry", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "purchaseCurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "locale", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "orderLines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "key": "tokenDetails", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaTokenDetails" + } + } + } + ] + } + }, + "type_:KlarnaTokenDetails": { + "name": "KlarnaTokenDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "masked_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiry_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalBillingAgreementApiSchema": { + "name": "PayPalBillingAgreementApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalBillingAgreementId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddressApiSchema" + } + }, + "description": "The PayPal customer's shipping address" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalExternalPayerInfoApiSchema": { + "name": "PayPalExternalPayerInfoApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalPayerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalOrderTokenApiSchema": { + "name": "PayPalOrderTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalOrderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentApiResponse": { + "name": "PaymentApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "requiredAction", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequiredActionApiSchema" + } + }, + "description": "Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\n\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + } + ] + } + }, + "type_:PaymentCardTokenApiSchema": { + "name": "PaymentCardTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "isNetworkTokenized", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BinDataApiSchema" + } + } + } + ] + } + }, + "type_:StatusReasonApiSchema": { + "name": "StatusReasonApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatusTypeEnum" + }, + "description": "Type of the status." + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeclineTypeEnum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED` this will be returned.\n\nDeclines of type `SOFT_DECLINE` may be retried,\nwhereas declines of type `HARD_DECLINE` should not be retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionDeclineReasonV2Enum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED`, this will be returned." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "In case of an error on the processor's part, we will return the message returned by the processor. This is usually a human readable error." + } + ] + } + }, + "type_:PaymentMethodTypeEnum": { + "name": "PaymentMethodTypeEnum", + "description": "Payment method type, where `OFF_SESSION_PAYMENT` is used for APM (Alternative Payment Method) payments and `PAYMENT_CARD` for traditional debit or credit cards. Please note that this list is different from one indicated on [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) page and values of this field will be changed in the future versions of the API.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PAYMENT_CARD" + }, + { + "value": "PAYPAL_ORDER" + }, + { + "value": "PAYPAL_BILLING_AGREEMENT" + }, + { + "value": "GOCARDLESS_MANDATE" + }, + { + "value": "KLARNA_AUTHORIZATION_TOKEN" + }, + { + "value": "KLARNA_CUSTOMER_TOKEN" + }, + { + "value": "PAY_NL_IDEAL" + }, + { + "value": "APAYA" + }, + { + "value": "OFF_SESSION_PAYMENT" + }, + { + "value": "CARD_OFF_SESSION_PAYMENT" + }, + { + "value": "APPLE_PAY" + }, + { + "value": "APPLE_PAY_ENCRYPTED_TOKEN" + }, + { + "value": "GOOGLE_PAY" + } + ] + } + }, + "type_:PaymentListApiResponse": { + "name": "PaymentListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PaymentSummaryApiSchema" + } + } + } + }, + { + "key": "nextCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "prevCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentRequiredActionApiSchema": { + "name": "PaymentRequiredActionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:BlockingPaymentActionTypeEnum" + }, + "description": "Action name" + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Human description of the required action to perform." + }, + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The client token to be returned to the SDK if a required action is returned." + } + ] + } + }, + "type_:PaymentSummaryApiSchema": { + "name": "PaymentSummaryApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatus" + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Your reference for the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The payment amount, in minor units. e.g. $7 would show as `700`." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`" + } + ] + } + }, + "type_:PaymentSummaryProcessorApiSchema": { + "name": "PaymentSummaryProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + } + ] + } + }, + "type_:PrepaidReloadableEnum": { + "name": "PrepaidReloadableEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RELOADABLE" + }, + { + "value": "NON_RELOADABLE" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:RecurringTransactionTypeEnum": { + "name": "RecurringTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + } + ] + } + }, + "type_:RecurringPaymentTypeSchema": { + "name": "RecurringPaymentTypeSchema", + "description": "Payment types, primarily to be used for recurring payments.\nNote: If you successfully vault a `SINGLE_USE` token on payment creation, then there's no need to set a value for this field and it will be flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all possible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RecurringTransactionTypeEnum" + } + } + }, + "type_:ProductTypeEnum": { + "name": "ProductTypeEnum", + "description": "An enumeration", + "shape": { + "type": "enum", + "values": [ + { + "value": "PHYSICAL" + }, + { + "value": "DIGITAL" + } + ] + } + }, + "type_:ThreeDSecureAuthResponseCodeEnum": { + "name": "ThreeDSecureAuthResponseCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchemaReasonCode": { + "name": "ThreeDSecureAuthenticationApiSchemaReasonCode", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Three D Secure Skipped Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureSkippedReasonCodeEnum" + } + }, + { + "displayName": "Three D Secure Failed Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureFailedReasonCodeEnum" + } + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchema": { + "name": "ThreeDSecureAuthenticationApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "responseCode", + "valueShape": { + "type": "id", + "id": "type_:ThreeDSecureAuthResponseCodeEnum" + } + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchemaReasonCode" + } + } + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ThreeDSecureFailedReasonCodeEnum": { + "name": "ThreeDSecureFailedReasonCodeEnum", + "description": "This enum is derived from the `transStatusReason` on page 218 of the\n[EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/uploads/documents/EMVCo_3DS_Spec_v220_122018.pdf)\n\n| Code | Description |\n| ---- | --------------------------------------- |\n| 01 | Card authentication failed |\n| 02 | Unknown Device |\n| 03 | Unsupported Device |\n| 04 | Exceeds authentication frequency limit |\n| 05 | Expired card |\n| 06 | Invalid card number |\n| 07 | Invalid transaction |\n| 08 | No Card record |\n| 09 | Security failure |\n| 10 | Stolen card |\n| 11 | Suspected fraud |\n| 12 | Transaction not permitted to cardholder |\n| 13 | Cardholder not enrolled in service |\n| 14 | Transaction timed out at the ACS |\n| 15 | Low confidence |\n| 16 | Medium confidence |", + "shape": { + "type": "enum", + "values": [ + { + "value": "UNKNOWN" + }, + { + "value": "REJECTED_BY_ISSUER" + }, + { + "value": "CARD_AUTHENTICATION_FAILED" + }, + { + "value": "UNKNOWN_DEVICE" + }, + { + "value": "UNSUPPORTED_DEVICE" + }, + { + "value": "EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "INVALID_TRANSACTION" + }, + { + "value": "NO_CARD_RECORD" + }, + { + "value": "SECURITY_FAILURE" + }, + { + "value": "STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER" + }, + { + "value": "CARDHOLDER_NOT_ENROLLED_IN_SERVICE" + }, + { + "value": "TRANSACTION_TIMED_OUT_AT_THE_ACS" + }, + { + "value": "LOW_CONFIDENCE" + }, + { + "value": "MEDIUM_CONFIDENCE" + }, + { + "value": "HIGH_CONFIDENCE" + }, + { + "value": "VERY_HIGH_CONFIDENCE" + }, + { + "value": "EXCEEDS_ACS_MAXIMUM_CHALLENGES" + }, + { + "value": "NON_PAYMENT_NOT_SUPPORTED" + }, + { + "value": "THREE_RI_NOT_SUPPORTED" + }, + { + "value": "ACS_TECHNICAL_ISSUE" + }, + { + "value": "DECOUPLED_REQUIRED_BY_ACS" + }, + { + "value": "DECOUPLED_MAX_EXPIRY_EXCEEDED" + }, + { + "value": "DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME" + }, + { + "value": "AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER" + }, + { + "value": "ACS_TIMED_OUT" + }, + { + "value": "INVALID_ACS_RESPONSE" + }, + { + "value": "ACS_SYSTEM_ERROR_RESPONSE" + }, + { + "value": "ERROR_GENERATING_CAVV" + }, + { + "value": "PROTOCOL_VERSION_NOT_SUPPORTED" + }, + { + "value": "TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING" + }, + { + "value": "REQUESTED_PROGRAM_NOT_SUPPORTED" + } + ] + } + }, + "type_:ThreeDSecureSkippedReasonCodeEnum": { + "name": "ThreeDSecureSkippedReasonCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "GATEWAY_UNAVAILABLE" + }, + { + "value": "DISABLED_BY_MERCHANT" + }, + { + "value": "NOT_SUPPORTED_BY_ISSUER" + }, + { + "value": "FAILED_TO_NEGOTIATE" + }, + { + "value": "UNKNOWN_ACS_RESPONSE" + }, + { + "value": "3DS_SERVER_ERROR" + }, + { + "value": "ACQUIRER_NOT_CONFIGURED" + }, + { + "value": "ACQUIRER_NOT_PARTICIPATING" + } + ] + } + }, + "type_:TokenTypeEnum": { + "name": "TokenTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MULTI_USE" + }, + { + "value": "SINGLE_USE" + } + ] + } + }, + "type_:DeclineTypeEnum": { + "name": "DeclineTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:TransactionDeclineReasonV2Enum": { + "name": "TransactionDeclineReasonV2Enum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:TransactionOverviewApiSchema": { + "name": "TransactionOverviewApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Date & time of the transaction (UTC)" + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Transaction amount in minor units" + }, + { + "key": "currencyCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "transactionType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionTypeEnum" + } + } + }, + { + "key": "processorTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Processor's unique identifier for the transaction" + }, + { + "key": "processorName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier of a processor." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Processor's main account identifier.\n\n- Adyen: Account code\n- Braintree: Merchant ID\n- Stripe: Account ID\"" + }, + { + "key": "processorStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Transaction status, please refer to the [Transaction Status Codes](#section/API-Usage-Guide/Payment-Status) table for more information" + }, + { + "key": "processorStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "If the transaction has a declined or failed status.\n\nOnly if the status is `DECLINED` or `FAILED`, otherwise `null`." + } + ] + } + }, + "type_:PaymentStatus": { + "name": "PaymentStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "FAILED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "SETTLED" + }, + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + } + ] + } + }, + "type_:PaymentStatusTypeEnum": { + "name": "PaymentStatusTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:TransactionTypeEnum": { + "name": "TransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SALE" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema": { + "name": "CoreApiApiCommonsSchemasAddessAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:AddressApiSchema": { + "name": "AddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "id", + "id": "type_:CountryCodeEnum" + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData": { + "name": "MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema Payment Methods Api", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchemaPaymentMethodsApi" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponse": { + "name": "MerchantPaymentMethodTokenApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Creation date & time of the object (UTC)" + }, + { + "key": "deletedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date & time when this object was revoked. (UTC)" + }, + { + "key": "deleted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this object has been revoked." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The vaulted payment method token." + }, + { + "key": "tokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "- `MULTI_USE` a vaulted token that can be re-used with subsequent payments" + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type associated with a token." + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID representing the customer" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly description given by the user" + }, + { + "key": "default", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this payment method is the default" + } + ] + } + }, + "type_:VerifiedMerchantPaymentMethodTokenApiResponse": { + "name": "VerifiedMerchantPaymentMethodTokenApiResponse", + "shape": { + "type": "object", + "extends": [ + "type_:MerchantPaymentMethodTokenApiResponse" + ], + "properties": [ + { + "key": "isVerified", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this payment method was verified" + } + ] + } + }, + "type_:MerchantPaymentMethodTokenListApiResponse": { + "name": "MerchantPaymentMethodTokenListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + } + } + ] + } + }, + "type_:VerifiedMerchantPaymentMethodTokenListApiResponse": { + "name": "VerifiedMerchantPaymentMethodTokenListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + } + } + ] + } + }, + "type_:PaymentCardTokenApiSchemaPaymentMethodsApi": { + "name": "PaymentCardTokenApiSchemaPaymentMethodsApi", + "description": "Used exclusively by the Payment Methods API", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "networkTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An ID for the transaction assigned by the card network. Used to correlate recurring payments." + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + "description": "The type of card, e.g. Debit, Credit" + } + ] + } + }, + "type_:ErrorObject": { + "name": "ErrorObject", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "errorId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An error ID" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A human description of the error" + }, + { + "key": "diagnosticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An ID that you can quote when contacting the Primer support team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11)." + }, + { + "key": "validationErrors", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "description": "Returned in case of a badly formed request" + } + ] + } + }, + "type_:four_hundred_ErrorResponse": { + "name": "four_hundred_ErrorResponse", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ErrorObject" + } + } + }, + "type_:four_hundred_twenty_two_ErrorResponse": { + "name": "four_hundred_twenty_two_ErrorResponse", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ErrorObject" + } + } + } + }, + "subpackages": { + "subpackage_clientSessionApi": { + "id": "subpackage_clientSessionApi", + "name": "Client Session API" + }, + "subpackage_paymentsApi": { + "id": "subpackage_paymentsApi", + "name": "Payments API" + }, + "subpackage_paymentMethodsApi": { + "id": "subpackage_paymentMethodsApi", + "name": "Payment Methods API" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-API-KEY", + "nameOverride": "apiKey" + } + } + }, + { + "id": "c5629660-3984-4ce0-989e-9c6fb0df36d9", + "endpoints": {}, + "websockets": {}, + "webhooks": { + "subpackage_paymentWebhooks.payment_status_webhook_event": { + "id": "subpackage_paymentWebhooks.payment_status_webhook_event", + "namespace": [ + "subpackage_paymentWebhooks" + ], + "description": "Primer notifies you with a `PAYMENT.STATUS` webhook when a payment's status has been updated. This is especially useful for asyncronous processor Connections, which do not respond with an upfront authorization.\nThe webhook events will arrive in the order that the payment status changes, for example you should expect a status of `PENDING`, then `AUTHORIZED`, then `SETTLED` (depending on how your workflow is set up).\nThe webhook body contains the full payment object.\n\nExample payment status notification:\n\n```JSON\n{\n \"eventType\":\"PAYMENT.STATUS\",\n \"date\":\"2021-02-21T15:36:16.367687\",\n \"notificationConfig\":{\n \"id\":\"cc51f9f0-7e1c-492b-9d37-f83a818f6070\",\n \"description\":\"Payment webhook\"\n },\n \"version\":\"2.2\",\n \"signedAt\": \"1689221338\",\n \"payment\":{\n \"id\":\"DdRZ6YY0\",\n \"date\":\"2021-02-21T15:34:16.367687\",\n \"dateUpdated\":\"2021-02-21T15:35:16.133701\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"customerId\":\"cust-123\",\n \"orderId\":\"order-123\",\n \"status\":\"SETTLED\",\n \"cardTokenType\":\"CARD_PAN\",\n \"customer\": {\n \"emailAddress\": \"test@primer.io\",\n \"mobileNumber\": \"0123456789\",\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"postalCode\": \"CB94BQ\",\n \"addressLine1\": \"10001 Alpha St\",\n \"countryCode\": \"GB\",\n \"city\": \"Cambridge\",\n \"state\": \"Cambridgeshire\"\n }\n },\n \"paymentMethod\":{\n \"paymentType\":\"FIRST_PAYMENT\",\n \"paymentMethodToken\":\"-lcWjvBAAs2DnIRXwxNjUzNTYzNjIy\",\n \"isVaulted\": \"false\",\n \"analyticsId\":\"LUi5pETUaVsdSEamK25L\",\n \"paymentMethodType\":\"PAYMENT_CARD\",\n \"paymentMethodData\":{\n \"last4Digits\":\"1111\",\n \"first6Digits\": \"411111\",\n \"expirationMonth\":\"03\",\n \"expirationYear\":\"2030\",\n \"cardholderName\":\"ADYEN\",\n \"network\":\"Visa\",\n \"isNetworkTokenized\":false,\n \"binData\":{\n \"network\":\"VISA\",\n \"issuerCountryCode\":\"US\",\n \"issuerName\":\"JPMORGAN CHASE BANK, N.A.\",\n \"regionalRestriction\":\"UNKNOWN\",\n \"accountNumberType\":\"UNKNOWN\",\n \"accountFundingType\":\"UNKNOWN\",\n \"prepaidReloadableIndicator\":\"NOT_APPLICABLE\",\n \"productUsageType\":\"UNKNOWN\",\n \"productCode\":\"UNKNOWN\",\n \"productName\":\"UNKNOWN\"\n }\n },\n \"authorizationType\": \"FINAL\",\n \"threeDSecureAuthentication\":{\n \"responseCode\":\"NOT_PERFORMED\"\n }\n },\n \"processor\":{\n \"name\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORasdasqNWFwi8c\",\n \"amountCaptured\":3000,\n \"amountRefunded\":0\n },\n \"transactions\":[\n {\n \"date\":\"2021-02-21T15:34:16.367687\",\n \"amount\":3000,\n \"currencyCode\":\"GBP\",\n \"transactionType\":\"SALE\",\n \"orderId\":\"order-123\",\n \"processorTransactionId\":\"pi_3L3edsGZasdasdc1iget38p\",\n \"processorName\":\"STRIPE\",\n \"processorMerchantId\":\"acct_1GORasvasdNWFwi8c\",\n \"processorStatus\":\"SETTLED\",\n \"cardTokenType\":\"CARD_PAN\"\n }\n ],\n \"riskData\":{\n \"fraudChecks\":{\n \"source\":\"riskified\",\n \"preAuthorizationResult\":\"THREE_DS\",\n \"postAuthorizationResult\":\"ACCEPT\"\n },\n \"cvvCheck\": {\n \"source\": \"processor\",\n \"result\": \"MATCHED\"\n },\n \"avsCheck\": {\n \"source\": \"processor\",\n \"result\": {\n \"streetAddress\": \"NOT_MATCHED\",\n \"postalCode\": \"NOT_VERIFIED\"\n }\n }\n }\n }\n}\n```\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentStatusWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "date": "2023-01-01T00:00:00Z", + "notificationConfig": { + "id": "string", + "description": "string" + }, + "version": "string", + "payment": { + "id": "string", + "date": "2023-01-01T00:00:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 0, + "customerId": "string", + "metadata": { + "string": {} + }, + "paymentMethod": { + "descriptor": "string", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "string", + "vaultedPaymentMethodToken": "string", + "analyticsId": "string", + "paymentMethodType": "string", + "paymentMethodData": { + "first6Digits": "string", + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "cardholderName": "string", + "network": "string", + "isNetworkTokenized": true, + "binData": { + "network": "string", + "issuerCountryCode": "AW", + "issuerName": "string", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE", + "reasonText": "string", + "protocolVersion": "string", + "challengeIssued": true + } + }, + "processor": { + "name": "string", + "processorMerchantId": "string", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + }, + "transactions": [ + { + "processorMerchantId": "string", + "transactionType": "SALE", + "processorTransactionId": "string", + "processorName": "string", + "processorStatus": "PENDING", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + } + } + ], + "riskData": { + "fraudChecks": { + "source": "string", + "preAuthorizationResult": "ACCEPT", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "string", + "result": "MATCHED" + }, + "avsCheck": { + "source": "string", + "result": { + "streetAddress": "MATCHED", + "postalCode": "MATCHED" + } + } + } + } + } + } + ] + }, + "subpackage_paymentWebhooks.payment_refund_webhook_event": { + "id": "subpackage_paymentWebhooks.payment_refund_webhook_event", + "namespace": [ + "subpackage_paymentWebhooks" + ], + "description": "Primer notifies you with a `PAYMENT.REFUND` Webhook when a refund request has been fully processed by a payment processor and the refund has reached a final state.\n\nCheck the transaction with the most recent `transactionType: \"REFUND\"` in the `transactions` array:\n- if `processorStatus` is `SETTLED`, the refund was successful and the funds have been returned to the customer\n- if `processorStatus` is `FAILED`, the refund was unsuccessful\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentRefundWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "date": "2023-01-01T00:00:00Z", + "notificationConfig": { + "id": "string", + "description": "string" + }, + "version": "string", + "payment": { + "id": "string", + "date": "2023-01-01T00:00:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 0, + "customerId": "string", + "metadata": { + "string": {} + }, + "paymentMethod": { + "descriptor": "string", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "string", + "vaultedPaymentMethodToken": "string", + "analyticsId": "string", + "paymentMethodType": "string", + "paymentMethodData": { + "first6Digits": "string", + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "cardholderName": "string", + "network": "string", + "isNetworkTokenized": true, + "binData": { + "network": "string", + "issuerCountryCode": "AW", + "issuerName": "string", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE", + "reasonText": "string", + "protocolVersion": "string", + "challengeIssued": true + } + }, + "processor": { + "name": "string", + "processorMerchantId": "string", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + }, + "transactions": [ + { + "processorMerchantId": "string", + "transactionType": "SALE", + "processorTransactionId": "string", + "processorName": "string", + "processorStatus": "PENDING", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR", + "message": "string" + } + } + ], + "riskData": { + "fraudChecks": { + "source": "string", + "preAuthorizationResult": "ACCEPT", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "string", + "result": "MATCHED" + }, + "avsCheck": { + "source": "string", + "result": { + "streetAddress": "MATCHED", + "postalCode": "MATCHED" + } + } + } + } + } + } + ] + }, + "subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event": { + "id": "subpackage_disputeChargebacksWebhooks.dispute_open_webhook_event", + "namespace": [ + "subpackage_disputeChargebacksWebhooks" + ], + "description": "Primer notifies you with a `DISPUTE.OPEN` webhook on newly opened disputes or chargebacks. This notification is unified across all processors.\n\nLearn more about [how Primer handles webhooks](https://primer.io/docs/how-primer-works/webhooks).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DisputeOpenWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "processorId": "string", + "processorDisputeId": "string", + "paymentId": "string", + "transactionId": "string", + "orderId": "string", + "primerAccountId": "string" + } + } + ] + }, + "subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event": { + "id": "subpackage_disputeChargebacksWebhooks.dispute_status_webhook_event", + "namespace": [ + "subpackage_disputeChargebacksWebhooks" + ], + "description": "Primer notifies you with a `DISPUTE.STATUS` webhook that will provide information on retrievals, disputes (also known as chargebacks), and preabritration filings.\n\nThis notification is supported for processors Adyen, Braintree, Checkout.com & PayPal.\n\nThe `DISPUTE.STATUS` event can be used to proactively communicate with customers, issue refunds, send disputes to risk tools, or to proactively defend disputes.\n\nThe `DISPUTE.STATUS` event is currently in an open beta stage, as we continue to add more processors.\n\nLearn more about [managing disputes at Primer](https://primer.io/docs/accept-payments/manage-disputes).\n", + "method": "POST", + "path": [], + "headers": [ + { + "key": "X-Signature-Primary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An [HMAC signature](https://en.wikipedia.org/wiki/HMAC) generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string." + }, + { + "key": "X-Signature-Secondary", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A secondary signature that is added when you have rotated your secret within the past 24 hours." + } + ], + "payload": { + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayload" + } + } + }, + "examples": [ + { + "payload": { + "eventType": "string", + "version": "string", + "type": "RETRIEVAL", + "status": "OPEN", + "primerAccountId": "string", + "transactionId": "string", + "orderId": "string", + "paymentId": "string", + "paymentMethod": { + "paymentMethodType": "string", + "paymentMethodData": { + "network": "string" + } + }, + "processor": "ADYEN", + "processorDisputeId": "string", + "receivedAt": "2023-01-01T00:00:00Z", + "challengeRequiredBy": "2023-01-01T00:00:00Z", + "reason": "string", + "reasonCode": "string", + "processorReason": "string", + "amount": 0, + "currency": "string", + "merchantId": "string" + } + } + ] + } + }, + "types": { + "type_:AccountFundingTypeEnum": { + "name": "AccountFundingTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT" + }, + { + "value": "DEBIT" + }, + { + "value": "PREPAID" + }, + { + "value": "CHARGE" + }, + { + "value": "DEFERRED_DEBIT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ApayaCustomerTokenApiSchema": { + "name": "ApayaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mx", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mnc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "mcc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BinDataApiSchema": { + "name": "BinDataApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuerCurrencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + } + }, + { + "key": "regionalRestriction", + "valueShape": { + "type": "id", + "id": "type_:CardRegionRestrictionEnum" + } + }, + { + "key": "accountNumberType", + "valueShape": { + "type": "id", + "id": "type_:CardAccountNumberTypeEnum" + } + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + { + "key": "prepaidReloadableIndicator", + "valueShape": { + "type": "id", + "id": "type_:PrepaidReloadableEnum" + } + }, + { + "key": "productUsageType", + "valueShape": { + "type": "id", + "id": "type_:CardProductTypeEnum" + } + }, + { + "key": "productCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "productName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:CardAccountNumberTypeEnum": { + "name": "CardAccountNumberTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PRIMARY_ACCOUNT_NUMBER" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardNetworkEnum": { + "name": "CardNetworkEnum", + "description": "[The list of available card networks and their `CARD_NETWORK_TYPE` can be found here.](https://www.notion.so/primerio/Payment-Method-Types-2b971a8c54c3452cae0b2fffe9167d72)", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:CardProductTypeEnum": { + "name": "CardProductTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CONSUMER" + }, + { + "value": "BUSINESS" + }, + { + "value": "GOVERNMENT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardRegionRestrictionEnum": { + "name": "CardRegionRestrictionEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DOMESTIC_USE_ONLY" + }, + { + "value": "NONE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData": { + "name": "PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Order Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalOrderTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Payment Session Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaPaymentSessionApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Ideal Pay Nl Token Api Schema", + "shape": { + "type": "id", + "id": "type_:IdealPayNlTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchema": { + "name": "PaymentResponsePaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment method token used to authorize the transaction." + }, + { + "key": "vaultedPaymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If the payment method token was vaulted, this is the new token. Use this token for recurring payments." + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type" + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchema" + } + } + } + ] + } + }, + "type_:CountryCodeEnum": { + "name": "CountryCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:Currency": { + "name": "Currency", + "description": "Enumerates all supported currencies", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentResponseProcessorApiSchema": { + "name": "PaymentResponseProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + }, + { + "key": "amountCaptured", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no capture was performed, this value will be set to `0`.\n\nIf one or more partial captures were performed, this value will be a sum\nof all partial capture amounts." + }, + { + "key": "amountRefunded", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no refund was performed, this value will be set to `0`.\n\nIf one or more partial refunds were performed, this value will be a sum\nof all partial refund amounts." + } + ] + } + }, + "type_:GoCardlessMandateApiSchema": { + "name": "GoCardlessMandateApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gocardlessMandateId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of a GoCardless mandate agreement" + } + ] + } + }, + "type_:IdealPayNlTokenApiSchema": { + "name": "IdealPayNlTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodConfigId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:KlarnaAddressApiSchema": { + "name": "KlarnaAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "phoneNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine3", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:KlarnaCustomerTokenApiSchema": { + "name": "KlarnaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaCustomerToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaPaymentSessionApiSchema": { + "name": "KlarnaPaymentSessionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaAuthorizationToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaSessionDetailsApiSchema": { + "name": "KlarnaSessionDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "recurringDescription", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "billingAddress", + "valueShape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + } + }, + { + "key": "purchaseCountry", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "purchaseCurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "locale", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "orderLines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "key": "tokenDetails", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaTokenDetails" + } + } + } + ] + } + }, + "type_:KlarnaTokenDetails": { + "name": "KlarnaTokenDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "masked_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiry_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalBillingAgreementApiSchema": { + "name": "PayPalBillingAgreementApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalBillingAgreementId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddressApiSchema" + } + }, + "description": "The PayPal customer's shipping address" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalExternalPayerInfoApiSchema": { + "name": "PayPalExternalPayerInfoApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalPayerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalOrderTokenApiSchema": { + "name": "PayPalOrderTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalOrderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentStatusWebhookPayloadNotificationConfig": { + "name": "PaymentStatusWebhookPayloadNotificationConfig", + "description": "The notification configuration details.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration ID." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration description." + } + ] + } + }, + "type_:PaymentStatusWebhookPayloadPayment": { + "name": "PaymentStatusWebhookPayloadPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream operations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + }, + { + "key": "riskData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskDataApiSchema" + } + } + } + ] + } + }, + "type_:PaymentStatusWebhookPayload": { + "name": "PaymentStatusWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `PAYMENT.STATUS` in this case." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date-time that the webhook was sent." + }, + { + "key": "notificationConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatusWebhookPayloadNotificationConfig" + } + }, + "description": "The notification configuration details." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "payment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatusWebhookPayloadPayment" + } + } + } + ] + } + }, + "type_:PaymentRefundWebhookPayloadNotificationConfig": { + "name": "PaymentRefundWebhookPayloadNotificationConfig", + "description": "The notification configuration details.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration ID." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The notification configuration description." + } + ] + } + }, + "type_:PaymentRefundWebhookPayloadPayment": { + "name": "PaymentRefundWebhookPayloadPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream operations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + }, + { + "key": "riskData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskDataApiSchema" + } + } + } + ] + } + }, + "type_:PaymentRefundWebhookPayload": { + "name": "PaymentRefundWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `PAYMENT.REFUND` in this case." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date-time that the webhook was sent." + }, + { + "key": "notificationConfig", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRefundWebhookPayloadNotificationConfig" + } + }, + "description": "The notification configuration details." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "payment", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRefundWebhookPayloadPayment" + } + } + } + ] + } + }, + "type_:DisputeOpenWebhookPayload": { + "name": "DisputeOpenWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the webhook raised. `DISPUTE.OPEN` in this case." + }, + { + "key": "processorId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the processor that generated the dispute." + }, + { + "key": "processorDisputeId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the corresponding connection dispute." + }, + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer payment corresponding to this dispute." + }, + { + "key": "transactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer transaction corresponding to this dispute." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the sale transaction that the dispute relates to." + }, + { + "key": "primerAccountId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your Primer merchant account." + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadType": { + "name": "DisputeStatusWebhookPayloadType", + "description": "The type of dispute event. More information on what the `type` field represents can be found in [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes)", + "shape": { + "type": "enum", + "values": [ + { + "value": "RETRIEVAL" + }, + { + "value": "DISPUTE" + }, + { + "value": "PREARBITRATION" + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadStatus": { + "name": "DisputeStatusWebhookPayloadStatus", + "description": "To see which statuses are applicable for a dispute `type`, and how we map `status`, please see [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes).", + "shape": { + "type": "enum", + "values": [ + { + "value": "OPEN" + }, + { + "value": "ACCEPTED" + }, + { + "value": "CHALLENGED" + }, + { + "value": "EXPIRED" + }, + { + "value": "CANCELLED" + }, + { + "value": "WON" + }, + { + "value": "LOST" + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData": { + "name": "DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadPaymentMethod": { + "name": "DisputeStatusWebhookPayloadPaymentMethod", + "description": "The payment method information for the payment that is now disputed.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + } + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadPaymentMethodPaymentMethodData" + } + } + } + ] + } + }, + "type_:DisputeStatusWebhookPayloadProcessor": { + "name": "DisputeStatusWebhookPayloadProcessor", + "description": "The payment processor that you submitted a payment to, and received a dispute notification from.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ADYEN" + }, + { + "value": "BRAINTREE" + } + ] + } + }, + "type_:DisputeStatusWebhookPayload": { + "name": "DisputeStatusWebhookPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "eventType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of event that triggered the webhook. This will have the value `DISPUTE.STATUS`. This indicates that a dispute notification was issued through a configured connection.\n\nUse these notifications to proactively communicate with your customer, issue refunds, or submit evidence to challenge disputes." + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payload version" + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadType" + } + }, + "description": "The type of dispute event. More information on what the `type` field represents can be found in [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes)" + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadStatus" + } + }, + "description": "To see which statuses are applicable for a dispute `type`, and how we map `status`, please see [Manage disputes](https://primer.io/docs/accept-payments/manage-disputes)." + }, + { + "key": "primerAccountId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your Primer merchant account." + }, + { + "key": "transactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer transaction corresponding to this dispute." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the sale transaction that the dispute relates to." + }, + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the Primer payment corresponding to this dispute." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadPaymentMethod" + } + }, + "description": "The payment method information for the payment that is now disputed." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DisputeStatusWebhookPayloadProcessor" + } + }, + "description": "The payment processor that you submitted a payment to, and received a dispute notification from." + }, + { + "key": "processorDisputeId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier for this dispute provided by the processor. This is shared across multiple dispute `type` and `status` relating to the same payment.\n\ne.g. as an `open` dispute that is later challenged will share a `proccessorDisputeId`." + }, + { + "key": "receivedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date and time at which Primer received the processor's dispute event. Provided as an ISO timestamp in UTC." + }, + { + "key": "challengeRequiredBy", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Time by which the merchant must challenge a dispute. This is provided by the processor, where available." + }, + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Primer’s unified reason that explains why the dispute was raised. This should not vary across processors for the same dispute `reasonCode`, unlike the `processorReason`." + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The dispute reason code for a dispute. This will be the same code provided by the card schemes." + }, + { + "key": "processorReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The dispute reason provided by the processor. This can vary across processors for the same dispute `reasonCode`, which is why we provide a unified field - `reason`." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The disputed amount. Note: this is not always the same as the payment amount.\n\nThis will be displayed in minor units.\n\ne.g. for $7, use `700`. Some currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`." + }, + { + "key": "currency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "merchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this dispute." + } + ] + } + }, + "type_:PaymentCardTokenApiSchema": { + "name": "PaymentCardTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "isNetworkTokenized", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BinDataApiSchema" + } + } + } + ] + } + }, + "type_:StatusReasonApiSchema": { + "name": "StatusReasonApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatusTypeEnum" + }, + "description": "Type of the status." + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeclineTypeEnum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED` this will be returned.\n\nDeclines of type `SOFT_DECLINE` may be retried,\nwhereas declines of type `HARD_DECLINE` should not be retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionDeclineReasonV2Enum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED`, this will be returned." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "In case of an error on the processor's part, we will return the message returned by the processor. This is usually a human readable error." + } + ] + } + }, + "type_:RiskDataApiSchema": { + "name": "RiskDataApiSchema", + "description": "Risk data associated with this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fraudChecks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudCheckApiSchema" + } + } + }, + { + "key": "cvvCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CvvCheckApiSchema" + } + } + }, + { + "key": "avsCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsCheckApiSchema" + } + } + } + ] + } + }, + "type_:FraudCheckApiSchema": { + "name": "FraudCheckApiSchema", + "description": "Results of the pre-authorization and post-authorization fraud checks.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "preAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + }, + { + "key": "postAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + } + ] + } + }, + "type_:FraudDecisionTypeEnum": { + "name": "FraudDecisionTypeEnum", + "description": "Possible fraud check outcomes.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ACCEPT" + }, + { + "value": "REFUSE" + }, + { + "value": "FAILED" + }, + { + "value": "THREE_DS" + } + ] + } + }, + "type_:CvvCheckApiSchema": { + "name": "CvvCheckApiSchema", + "description": "Results of any external CVV check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:AvsCheckApiSchema": { + "name": "AvsCheckApiSchema", + "description": "Results of any external AVS check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsRiskAssessmentValues" + } + } + } + ] + } + }, + "type_:AvsRiskAssessmentValues": { + "name": "AvsRiskAssessmentValues", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "streetAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:RiskAssessmentStatusEnum": { + "name": "RiskAssessmentStatusEnum", + "description": "Possible risk assessment values for CVV and AVS checks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MATCHED" + }, + { + "value": "NOT_MATCHED" + }, + { + "value": "NOT_VERIFIED" + }, + { + "value": "NOT_PROVIDED" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "SKIPPED" + } + ] + } + }, + "type_:PaymentMethodTypeEnum": { + "name": "PaymentMethodTypeEnum", + "description": "[The list of available payment methods and their `PAYMENT_METHOD_TYPE` can be found here.](https://www.notion.so/primerio/Payment-Method-Types-2b971a8c54c3452cae0b2fffe9167d72)", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:PrepaidReloadableEnum": { + "name": "PrepaidReloadableEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RELOADABLE" + }, + { + "value": "NON_RELOADABLE" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ThreeDSecureAuthResponseCodeEnum": { + "name": "ThreeDSecureAuthResponseCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchemaReasonCode": { + "name": "ThreeDSecureAuthenticationApiSchemaReasonCode", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Three D Secure Skipped Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureSkippedReasonCodeEnum" + } + }, + { + "displayName": "Three D Secure Failed Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureFailedReasonCodeEnum" + } + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchema": { + "name": "ThreeDSecureAuthenticationApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "responseCode", + "valueShape": { + "type": "id", + "id": "type_:ThreeDSecureAuthResponseCodeEnum" + } + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchemaReasonCode" + } + } + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ThreeDSecureFailedReasonCodeEnum": { + "name": "ThreeDSecureFailedReasonCodeEnum", + "description": "This enum is derived from the `transStatusReason` on page 218 of the\n[EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/uploads/documents/EMVCo_3DS_Spec_v220_122018.pdf)\n\n| Code | Description |\n| ---- | --------------------------------------- |\n| 01 | Card authentication failed |\n| 02 | Unknown Device |\n| 03 | Unsupported Device |\n| 04 | Exceeds authentication frequency limit |\n| 05 | Expired card |\n| 06 | Invalid card number |\n| 07 | Invalid transaction |\n| 08 | No Card record |\n| 09 | Security failure |\n| 10 | Stolen card |\n| 11 | Suspected fraud |\n| 12 | Transaction not permitted to cardholder |\n| 13 | Cardholder not enrolled in service |\n| 14 | Transaction timed out at the ACS |\n| 15 | Low confidence |\n| 16 | Medium confidence |", + "shape": { + "type": "enum", + "values": [ + { + "value": "UNKNOWN" + }, + { + "value": "REJECTED_BY_ISSUER" + }, + { + "value": "CARD_AUTHENTICATION_FAILED" + }, + { + "value": "UNKNOWN_DEVICE" + }, + { + "value": "UNSUPPORTED_DEVICE" + }, + { + "value": "EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "INVALID_TRANSACTION" + }, + { + "value": "NO_CARD_RECORD" + }, + { + "value": "SECURITY_FAILURE" + }, + { + "value": "STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER" + }, + { + "value": "CARDHOLDER_NOT_ENROLLED_IN_SERVICE" + }, + { + "value": "TRANSACTION_TIMED_OUT_AT_THE_ACS" + }, + { + "value": "LOW_CONFIDENCE" + }, + { + "value": "MEDIUM_CONFIDENCE" + }, + { + "value": "HIGH_CONFIDENCE" + }, + { + "value": "VERY_HIGH_CONFIDENCE" + }, + { + "value": "EXCEEDS_ACS_MAXIMUM_CHALLENGES" + }, + { + "value": "NON_PAYMENT_NOT_SUPPORTED" + }, + { + "value": "THREE_RI_NOT_SUPPORTED" + }, + { + "value": "ACS_TECHNICAL_ISSUE" + }, + { + "value": "DECOUPLED_REQUIRED_BY_ACS" + }, + { + "value": "DECOUPLED_MAX_EXPIRY_EXCEEDED" + }, + { + "value": "DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME" + }, + { + "value": "AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER" + }, + { + "value": "ACS_TIMED_OUT" + }, + { + "value": "INVALID_ACS_RESPONSE" + }, + { + "value": "ACS_SYSTEM_ERROR_RESPONSE" + }, + { + "value": "ERROR_GENERATING_CAVV" + }, + { + "value": "PROTOCOL_VERSION_NOT_SUPPORTED" + }, + { + "value": "TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING" + }, + { + "value": "REQUESTED_PROGRAM_NOT_SUPPORTED" + } + ] + } + }, + "type_:ThreeDSecureSkippedReasonCodeEnum": { + "name": "ThreeDSecureSkippedReasonCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "GATEWAY_UNAVAILABLE" + }, + { + "value": "DISABLED_BY_MERCHANT" + }, + { + "value": "NOT_SUPPORTED_BY_ISSUER" + }, + { + "value": "FAILED_TO_NEGOTIATE" + }, + { + "value": "UNKNOWN_ACS_RESPONSE" + }, + { + "value": "3DS_SERVER_ERROR" + }, + { + "value": "ACQUIRER_NOT_CONFIGURED" + }, + { + "value": "ACQUIRER_NOT_PARTICIPATING" + } + ] + } + }, + "type_:DeclineTypeEnum": { + "name": "DeclineTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:TransactionDeclineReasonV2Enum": { + "name": "TransactionDeclineReasonV2Enum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:TransactionOverviewApiSchema": { + "name": "TransactionOverviewApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "transactionType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionTypeEnum" + } + } + }, + { + "key": "processorTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Processor's unique identifier for the transaction" + }, + { + "key": "processorName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier of a processor." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Processor's main account identifier.\n\n- Adyen: Account code\n- Braintree: Merchant ID\n- Stripe: Account ID\"" + }, + { + "key": "processorStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Transaction status, please refer to the [Transaction Status Codes](#section/API-Usage-Guide/Payment-Status) table for more information" + }, + { + "key": "processorStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "If the transaction has a declined or failed status.\n\nOnly if the status is `DECLINED` or `FAILED`, otherwise `null`." + } + ] + } + }, + "type_:PaymentStatus": { + "name": "PaymentStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "FAILED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "SETTLED" + }, + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + } + ] + } + }, + "type_:PaymentStatusTypeEnum": { + "name": "PaymentStatusTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:TransactionTypeEnum": { + "name": "TransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SALE" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:AddressApiSchema": { + "name": "AddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "id", + "id": "type_:CountryCodeEnum" + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:RecurringTransactionTypeEnum": { + "name": "RecurringTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + } + ] + } + }, + "type_:RecurringPaymentTypeSchema": { + "name": "RecurringPaymentTypeSchema", + "description": "Payment types, primarily to be used for recurring payments.\nNote: If you successfully vault a `SINGLE_USE` token on payment creation, then there's no need to set a value for this field and it will be flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all possible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RecurringTransactionTypeEnum" + } + } + }, + "type_:AuthorizationTypeEnum": { + "name": "AuthorizationTypeEnum", + "description": "Type of authorization for the payment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ESTIMATED" + }, + { + "value": "FINAL" + } + ] + } + }, + "type_:OptionalAddressApiSchema": { + "name": "OptionalAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:CheckoutCustomerDetailsApiSchema": { + "name": "CheckoutCustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.
Must be a valid email address. Supports internationalized email addresses." + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer billing address." + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + } + }, + "subpackages": { + "subpackage_paymentWebhooks": { + "id": "subpackage_paymentWebhooks", + "name": "paymentWebhooks" + }, + "subpackage_disputeChargebacksWebhooks": { + "id": "subpackage_disputeChargebacksWebhooks", + "name": "disputeChargebacksWebhooks" + } + }, + "auths": {} + }, + { + "id": "0d20b529-65ad-4f2b-99a5-562a73e0b3c9", + "endpoints": { + "subpackage_clientSessionApi.retrieveClientSideToken": { + "id": "subpackage_clientSessionApi.retrieveClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "This API call retrieves all the details associated with the client session corresponding to the client token that is provided in the request. The fields with empty values are excluded from the response.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token corresponding to the client session to retrieve" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "clientToken": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -d clientToken=string", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "clientToken": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -d clientToken=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_clientSessionApi.createClientSideToken": { + "id": "subpackage_clientSessionApi.createClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "Creating a client session generates a client token: a temporary key used to initialize [Universal Checkout](https://primer.io/docs/accept-payments/setup-universal-checkout/installation/web) and authenticate it against your account.\n\nUniversal Checkout automatically retrieves all the settings from the client session and the Dashboard to configure the payment methods and the checkout experience.\n\nNote:\nWhen creating a Client Session, please make sure to provide `currencyCode`, `orderId`, and at least one of `amount` or `lineItems`.\nIf any of these are not yet available, you can provide them w\nhen making the payment request.\n\nPOST /client-session does not have required fields as all fields are not always known when a client session is created.\nUse PATCH /client-session to update the parameters throughout the checkout session.\n\nClient tokens expire after 24 hours.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nCreate a client session token with a `customerId` to enable the client-side SDK to retrieve and manage your customer's saved payment methods. A client session token also enables saving payment methods against this customer id." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionWithTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + }, + "warnings": { + "type": "TAXJAR", + "code": "MISSING_DATA" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"currencyCode\": \"AED\",\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\",\n \"productData\": {}\n }\n ],\n \"countryCode\": \"AW\",\n \"retailerCountryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"orderedAllowedCardNetworks\": [\n \"AMEX\"\n ],\n \"options\": {\n \"\": {\n \"surcharge\": {}\n },\n \"PAYMENT_CARD\": {\n \"networks\": {\n \"AMEX\": {\n \"surcharge\": {}\n },\n \"DANKORT\": {\n \"surcharge\": {}\n },\n \"DINERS_CLUB\": {\n \"surcharge\": {}\n },\n \"DISCOVER\": {\n \"surcharge\": {}\n },\n \"ENROUTE\": {\n \"surcharge\": {}\n },\n \"ELO\": {\n \"surcharge\": {}\n },\n \"HIPER\": {\n \"surcharge\": {}\n },\n \"INTERAC\": {\n \"surcharge\": {}\n },\n \"JCB\": {\n \"surcharge\": {}\n },\n \"MAESTRO\": {\n \"surcharge\": {}\n },\n \"MASTERCARD\": {\n \"surcharge\": {}\n },\n \"MIR\": {\n \"surcharge\": {}\n },\n \"PRIVATE_LABEL\": {\n \"surcharge\": {}\n },\n \"UNIONPAY\": {\n \"surcharge\": {}\n },\n \"VISA\": {\n \"surcharge\": {}\n },\n \"OTHER\": {\n \"surcharge\": {}\n }\n }\n }\n },\n \"authorizationType\": \"ESTIMATED\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_clientSessionApi.updateClientSideToken": { + "id": "subpackage_clientSessionApi.updateClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "You can update a clients session created earlier with the `PATCH /client-session` [API call](#operation/create_client_side_token_client_session_post).\n\nThe only required field for the request is `clientToken`. Other supported request fields are same as for the `POST /client-session` [API call](#operation/create_client_side_token_client_session_post).\n\nYou need to specify only the fields you wish to update. However, if the items that are to be updated are of type `array`, then you need to provide the complete array along with modified items.\n\nIf you wish to update nested fields on the client session, such as the customer `emailAddress` field, you can pass the `customer` object with only one field, `emailAddress`, to update.\n\nIf you simply wish to clear the value of the field, pass `null` as your input.\n\nYou can update `paymentMethod.vaultOnSuccess` field but updating of the `paymentMethod.options` field through `PATCH /client-session` is not supported.\n\nThe response will contain all the fields of the client session including the ones that were changed.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token for use in the Primer-JS SDK obtained via `POST` /client-session API call." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the order." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "\nThe 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nProvide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method. Provide the entire object to update it. Anything provided previously will be overwritten." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "orderedAllowedCardNetworks": [ + "AMEX" + ], + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + }, + "authorizationType": "ESTIMATED" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\",\n \"productData\": {}\n }\n ],\n \"countryCode\": \"AW\",\n \"retailerCountryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"orderedAllowedCardNetworks\": [\n \"AMEX\"\n ],\n \"options\": {\n \"\": {\n \"surcharge\": {}\n },\n \"PAYMENT_CARD\": {\n \"networks\": {\n \"AMEX\": {\n \"surcharge\": {}\n },\n \"DANKORT\": {\n \"surcharge\": {}\n },\n \"DINERS_CLUB\": {\n \"surcharge\": {}\n },\n \"DISCOVER\": {\n \"surcharge\": {}\n },\n \"ENROUTE\": {\n \"surcharge\": {}\n },\n \"ELO\": {\n \"surcharge\": {}\n },\n \"HIPER\": {\n \"surcharge\": {}\n },\n \"INTERAC\": {\n \"surcharge\": {}\n },\n \"JCB\": {\n \"surcharge\": {}\n },\n \"MAESTRO\": {\n \"surcharge\": {}\n },\n \"MASTERCARD\": {\n \"surcharge\": {}\n },\n \"MIR\": {\n \"surcharge\": {}\n },\n \"PRIVATE_LABEL\": {\n \"surcharge\": {}\n },\n \"UNIONPAY\": {\n \"surcharge\": {}\n },\n \"VISA\": {\n \"surcharge\": {}\n },\n \"OTHER\": {\n \"surcharge\": {}\n }\n }\n }\n },\n \"authorizationType\": \"ESTIMATED\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.listPayments": { + "id": "subpackage_paymentsApi.listPayments", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a list of your payments.\n\nResults are paginated, they will only return up to 100 payments maximum.\nTo access the next page of result, set the `cursor` query parameter to the value of `nextCursor` in\nyour current result payload. Use `prevCursor` to go back to the previous page.\n\n**Note:** this endpoint returns a list of\nsummarized payments. Not all payments attributes are present. You can use\nthe query parameters to filter payments. You can separate multiple query parameters with the `&` symbol.\nQuery parameters with types of the form \"Array of strings\" (such as the status parameter) can be specified as a comma-separated list.\n\nFor example, if you wanted to get both `FAILED` and `CANCELLED` payments, for customer `john-123`, you would use:\n\n```bash\ncurl --location --request GET 'https://api.primer.io/payments?status=FAILED,CANCELLED&customer_id=john-123' \\\n--header 'X-Api-Key: '\n```\n\nYou can alternatively specify a list by repeating the parameter multiple times.\n\n**Note:** payments will be available within a minute from being created.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Filter payments by their status." + }, + { + "key": "payment_method_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Filter payments by their payment method type." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment processor." + }, + { + "key": "currency_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment currency.\ne.g. use `USD` for US dollars." + }, + { + "key": "from_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments from this date (inclusive)." + }, + { + "key": "to_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments up to this date (inclusive)." + }, + { + "key": "order_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Return payments related to this order ID." + }, + { + "key": "min_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount minimum (inclusive)." + }, + { + "key": "max_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount max (inclusive)." + }, + { + "key": "customer_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the customer that has made the payment." + }, + { + "key": "merchant_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the merchant involved in the payment." + }, + { + "key": "customer_email_address", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Email of the customer that has made the payment." + }, + { + "key": "last_4_digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Last 4 digits of the card used for the payment." + }, + { + "key": "paypal_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Paypal email address associated with the payment." + }, + { + "key": "klarna_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Klarna email address associated with the payment." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of payments to return per page." + }, + { + "key": "cursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If results are paginated, pass the `nextCursor` to access next page." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentListApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "string", + "date": "2024-01-15T09:30:00Z", + "dateUpdated": "2024-01-15T09:30:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 1, + "processor": { + "name": "string" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.createPayment": { + "id": "subpackage_paymentsApi.createPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nCreate and authorize a payment for a given customer order. You\nshould provide a payment method token here to avoid PCI implications.\n\nIf only a payment method token is passed, the values passed with the Client Session is used to determine the amount, currency etc.\nNote: `amount`, `currencyCode` and `orderId` are required during payment creation. Make sure to pass these fields when creating a client session, or if not yet available, when creating a payment.\n\nAll fields provided on this request will take preference over any field on the `order` associated with the client session. E.g. if you pass `amount` on this request, it will override the `amount` on the `order` associated with the Client Session.\nParameters that are not on this request will be fetched from previously created Client Session and merged. E.g. if you specify `customer.billingAddress` in Client Session and then pass `customer.emailAddress` data with this request, it will automatically merge the `customer` fields and use both `billingAddress` and `emailAddress` for later calculations.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`. The minimum amount is 0." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment method token used to authorize the payment.\n" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nThis attribute is required if `paymentMethod.vaultOnSuccess` is set to `True`." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n" + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequestPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string", + "currencyCode": "AED", + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT", + "authorizationType": "ESTIMATED" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\",\n \"currencyCode\": \"AED\",\n \"order\": {\n \"lineItems\": [\n {\n \"amount\": 1,\n \"productType\": \"PHYSICAL\",\n \"productData\": {}\n }\n ],\n \"countryCode\": \"AW\",\n \"retailerCountryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\",\n \"authorizationType\": \"ESTIMATED\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.authorizePayment": { + "id": "subpackage_paymentsApi.authorizePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nManually authorize a payment using a provided processor. This is useful if you want to authorize a payment without a workflow action.\nThe processor merchant ID must be provided which can be found on the [Integrations page](https://dashboard.primer.io/integrations).\nThe processor name is optional but it must be provided if your account has multiple processors configured which share the same merchant IDs.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/authorize" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the payment to authorize." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "processor", + "valueShape": { + "type": "id", + "id": "type_:PaymentAuthorizationRequestProcessorApiSchema" + }, + "description": "The payment processor to use for this payment." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_four_ErrorResponse" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_nine_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/authorize", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "acct_myprocessor_1234" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "MYPROCESSOR", + "processorMerchantId": "acct_myprocessor_1234", + "amountCaptured": 42, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_myprocessor_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "MYPROCESSOR", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/authorize \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"acct_myprocessor_1234\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 409, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "paymentId": "string", + "status": "string", + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/authorize", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "processor": { + "processorMerchantId": "string" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/authorize \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"processor\": {\n \"processorMerchantId\": \"string\"\n }\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.capturePayment": { + "id": "subpackage_paymentsApi.capturePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nIf you have successfully authorized a payment, you can now\nfully capture, or partially capture funds from the authorized payment, depending\non whether your selected payment processor supports it. The payment will\nbe updated to `SETTLED` or `SETTLING`, depending on the payment method type.\n\nThe payload sent in this capture request is completely optional. If you don't\nsend a payload with the capture request, the full amount that was authorized\nwill be sent for capture. Below are the available payload attributes, which\ngive you more granular control when capturing funds, if you require it.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/capture" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the payment to capture." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to capture, in minor units. The currency used on authorization is assumed.\n\nIf no amount is specified it defaults to the full amount." + }, + { + "key": "final", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether the capture request is the final capture request.\n\nAfter a final capture, no subsequent captures are allowed." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_paymentsApi:PaymentCaptureApiRequestOrder" + } + }, + "description": "More information associated with the order." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional payment metadata.\nThis only takes effect if the payment was created via the New Workflows ([read more here](https://primer.io/docs/changelog/migration-guides/new-workflows)).\nA dictionary of key-value pairs where the values can only be strings or integers. Keys which already exist in the payment metadata will be overwritten." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_nine_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/capture", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "order": { + "retailerCountryCode": "AW" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "SETTLED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 42, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/capture \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"order\": {\n \"retailerCountryCode\": \"AW\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 409, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "paymentId": "string", + "status": "string", + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.cancelPayment": { + "id": "subpackage_paymentsApi.cancelPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nProvided the payment has not reached `SETTLED` status, Primer will\nsend a \"void\" request to the payment processor, thereby cancelling the payment\nand releasing the hold on customer funds. Upon success, the payment will transition\nto `CANCELLED`. The payload is optional.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/cancel" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to cancel." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the cancellation. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_nine_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/cancel", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "CANCELLED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "CANCELLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/cancel \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/cancel", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/cancel \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/cancel", + "responseStatusCode": 409, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "paymentId": "string", + "status": "string", + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/cancel \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.refundPayment": { + "id": "subpackage_paymentsApi.refundPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nBy default, this request will refund the full amount.\n\nOptionally, pass in a lesser amount for a partial refund.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/refund" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to refund." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to refund the customer, in minor units. e.g. for $7, use `700`.\n\nDefaults to remaining non-refunded amount." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optionally you can pass a specific order ID for the refund.\n\nBy default this will be set to the original `orderId` given on payment creation." + }, + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the refund. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_nine_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/refund", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "SETTLED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 42, + "amountRefunded": 42 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/refund \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 409, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "paymentId": "string", + "status": "string", + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.resumePayment": { + "id": "subpackage_paymentsApi.resumePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nResume a payment's workflow execution from a paused state. This\nis usually required when a Workflow was paused in order to get further information\nfrom the customer, or when waiting for an asynchronous response from a third\nparty connection.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/resume" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to resume." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "resumeToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A token containing any information that is sent back from the checkout to complete a blocked payment flow." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/resume", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/resume", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.adjustAuthorization": { + "id": "subpackage_paymentsApi.adjustAuthorization", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nAdjust authorized amount. This is only possible if `authorizationType` was set to\n`ESTIMATED` when the payment was created, and the mechanism is supported by the payment method.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/adjust-authorization" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment for adjusting authorization." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The **final** amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_four_ErrorResponse" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_nine_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/adjust-authorization", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "amount": 1 + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "FIRST_PAYMENT", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "ESTIMATED" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "THREE_DS", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "NOT_MATCHED", + "postalCode": "NOT_VERIFIED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/adjust-authorization \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 1\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/adjust-authorization", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "amount": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/adjust-authorization \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/adjust-authorization", + "responseStatusCode": 404, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "amount": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/adjust-authorization \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/adjust-authorization", + "responseStatusCode": 409, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "amount": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "paymentId": "string", + "status": "string", + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/adjust-authorization \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/adjust-authorization", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "amount": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/adjust-authorization \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"amount\": 0\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.getPaymentById": { + "id": "subpackage_paymentsApi.getPaymentById", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a payment by its ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to retrieve." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "dateUpdated": "2021-02-21T15:36:17.133701", + "status": "AUTHORIZED", + "cardTokenType": "CARD_PAN", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "lineItems": [ + { + "amount": 1, + "productType": "PHYSICAL", + "productData": {} + } + ], + "countryCode": "AW", + "retailerCountryCode": "AW", + "fees": [ + { + "amount": 1 + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentType": "SUBSCRIPTION", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "isVaulted": true, + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + }, + "authorizationType": "FINAL" + }, + "processor": { + "name": "STRIPE", + "processorMerchantId": "acct_stripe_1234", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "date": "string", + "amount": 1, + "currencyCode": "AED", + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "cardTokenType": "CARD_PAN" + } + ], + "riskData": { + "fraudChecks": { + "source": "FRAUD_PROVIDER", + "preAuthorizationResult": "ACCEPT", + "postAuthorizationResult": "ACCEPT" + }, + "cvvCheck": { + "source": "PROCESSOR", + "result": "MATCHED" + }, + "avsCheck": { + "source": "PROCESSOR", + "result": { + "streetAddress": "MATCHED", + "postalCode": "MATCHED" + } + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post": { + "id": "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "

\n\nSave a `SINGLE_USE` payment method token so it can be used\nagain later.\n\nIf you try to vault an already vaulted token, you will get the existing vaulted token back.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + }, + { + "type": "literal", + "value": "/vault" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Payment method token to store." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID representing the customer" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/vault", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "paymentMethodType": "PAYMENT_CARD" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/vault", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/vault", + "responseStatusCode": 422, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get": { + "id": "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Retrieve a list of stored payment methods for a customer.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payment-instruments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "customer_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Return payment methods for this customer ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenListApiResponse" + } + } + }, + "examples": [ + { + "path": "/payment-instruments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "customer_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "paymentMethodType": "PAYMENT_CARD" + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payment-instruments \\\n -H \"X-API-KEY: \" \\\n -d customer_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete": { + "id": "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Delete a saved payment method.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to delete." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + }, + "paymentMethodType": "PAYMENT_CARD" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post": { + "id": "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Update a saved payment method to be the default stored payment method for a customer.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "paymentMethodToken" + }, + { + "type": "literal", + "value": "/default" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to set to default." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/default", + "responseStatusCode": 200, + "pathParameters": { + "paymentMethodToken": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "DOMESTIC_USE_ONLY", + "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", + "accountFundingType": "CREDIT", + "prepaidReloadableIndicator": "RELOADABLE", + "productUsageType": "CONSUMER", + "productCode": "string", + "productName": "string" + } + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:paymentMethodToken/default", + "responseStatusCode": 400, + "pathParameters": { + "paymentMethodToken": ":paymentMethodToken" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_observabilityApiBeta.external_payment": { + "id": "subpackage_observabilityApiBeta.external_payment", + "namespace": [ + "subpackage_observabilityApiBeta" + ], + "description": "The Observability API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreating a payment with the Observability API sends external payments data to Primer to populate [Observability Payment Insights dashboards](https://primer.io/observability). Payments created through the [Payments API](/reference/create_payment_payments_post) will be automatically populated and do not need to be sent in the Observability API.\n\nCreate an API key with the `observability-payments:write` scope.\n\nEach record must be created with a unique `paymentId`. To update a payment record with new data use the `PATCH` endpoint.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/observability/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentsInsightsPayment" + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentsInsightsPayment" + } + } + }, + "examples": [ + { + "path": "/observability/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paymentId": "string", + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "amount": 1, + "createdAt": "2024-01-15T09:30:00Z", + "order": { + "id": "string", + "countryCode": "AW" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentId": "string", + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "amount": 1, + "createdAt": "2024-01-15T09:30:00Z", + "order": { + "id": "string", + "countryCode": "AW" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/observability/payments \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentId\": \"string\",\n \"currencyCode\": \"AED\",\n \"processor\": {\n \"name\": \"APAYA\"\n },\n \"amount\": 1,\n \"createdAt\": \"2024-01-15T09:30:00Z\",\n \"order\": {\n \"id\": \"string\",\n \"countryCode\": \"AW\"\n },\n \"paymentMethod\": {\n \"paymentMethodType\": \"PAYMENT_CARD\",\n \"data\": {\n \"binData\": {\n \"network\": \"AMEX\",\n \"issuerCountryCode\": \"AW\"\n }\n },\n \"threeDSecureAuthentication\": {\n \"responseCode\": \"NOT_PERFORMED\"\n }\n },\n \"status\": \"DECLINED\",\n \"statusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n },\n \"paymentType\": \"FIRST_PAYMENT\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_observabilityApiBeta.external_payment_update": { + "id": "subpackage_observabilityApiBeta.external_payment_update", + "namespace": [ + "subpackage_observabilityApiBeta" + ], + "description": "The Observability API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nYou can update payments created earlier through the Observability API with this endpoint. The only required field for the request is `paymentId`. Other supported request fields are the same as for the [create an external payment](/reference/external_payment) API call.\n\nIf you wish to update nested fields on the payment, you only need to pass the fields that you wish to update. For example to update the processor name, you would pass in `processor.name` only.\n\nThe response will contain all the fields of the payment including the ones that were changed.", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/observability/payments/" + }, + { + "type": "pathParameter", + "value": "paymentId" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "paymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment ID.\n\nThe payment ID must be unique. You can use this unique payment ID to update payment details." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode" + } + }, + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsProcessor" + } + } + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer,\nin minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units.\nIn this case you should use the value as it is, without any formatting.\nFor example for ¥100, use `100`.\nThe minimum amount is 0." + }, + { + "key": "createdAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The payment creation date and time (UTC) in [ISO 8601 format](\nhttps://en.wikipedia.org/wiki/ISO_8601).\n\nCannot be updated in partial updates PATCH." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsOrder" + } + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus" + } + }, + "description": "See the payment [status table](\nhttps://apiref.primer.io/docs#payment-status) for more information." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReason" + } + }, + "description": "Pass more information regarding the payment's status in this field.\n\nThis is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentMethod" + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nAd dictionary of key-value pairs where the values can only be strings or integers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"88278a\"}`" + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType" + } + }, + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n\n| paymentType | Use case |\n| --- | --- |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |" + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment,\nas it would typically appear on a bank statement." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentsInsightsPayment" + } + } + }, + "examples": [ + { + "path": "/observability/payments/string", + "responseStatusCode": 200, + "pathParameters": { + "paymentId": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "order": { + "id": "string", + "countryCode": "AW" + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentId": "string", + "currencyCode": "AED", + "processor": { + "name": "APAYA" + }, + "amount": 1, + "createdAt": "2024-01-15T09:30:00Z", + "order": { + "id": "string", + "countryCode": "AW" + }, + "paymentMethod": { + "paymentMethodType": "PAYMENT_CARD", + "data": { + "binData": { + "network": "AMEX", + "issuerCountryCode": "AW" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED" + } + }, + "status": "DECLINED", + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "paymentType": "FIRST_PAYMENT" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PATCH https://api.sandbox.primer.io/observability/payments/string \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"currencyCode\": \"AED\",\n \"processor\": {\n \"name\": \"APAYA\"\n },\n \"order\": {\n \"id\": \"string\",\n \"countryCode\": \"AW\"\n },\n \"status\": \"DECLINED\",\n \"statusReason\": {\n \"type\": \"APPLICATION_ERROR\",\n \"declineType\": \"SOFT_DECLINE\",\n \"code\": \"ERROR\"\n },\n \"paymentMethod\": {\n \"paymentMethodType\": \"PAYMENT_CARD\",\n \"data\": {\n \"binData\": {\n \"network\": \"AMEX\",\n \"issuerCountryCode\": \"AW\"\n }\n },\n \"threeDSecureAuthentication\": {\n \"responseCode\": \"NOT_PERFORMED\"\n }\n },\n \"paymentType\": \"FIRST_PAYMENT\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_loyaltyApi.get_loyalty_customer": { + "id": "subpackage_loyaltyApi.get_loyalty_customer", + "namespace": [ + "subpackage_loyaltyApi" + ], + "description": "The Loyalty API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreate an API key with the `loyalty-transactions:read` scopes.\n\nGet a loyalty customer by ID and connection ID. This includes the customer's points balance.\n\nThe `connectionId` is the unique Primer identifier for your loyalty provider connection. Primer will provide this once the loyalty provider connection is created.\n\nThe `customerId` refers to the customer identifier on the loyalty provider's side.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/loyalty-customers/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + } + ], + "queryParameters": [ + { + "key": "connectionId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Primer connection configuration." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LoyaltyApiBalanceResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/loyalty-customers/string", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": { + "connectionId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-customers/string \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-customers/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": { + "connectionId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-customers/:id \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_loyaltyApi.get_loyalty_customer_transactions": { + "id": "subpackage_loyaltyApi.get_loyalty_customer_transactions", + "namespace": [ + "subpackage_loyaltyApi" + ], + "description": "The Loyalty API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreate an API key with the `loyalty-transactions:read` scopes.\n\nGet all your loyalty transactions. You can filter by `connectionId` (recommended) and by `customerId` and `orderId`.\n\nAdditionally provide a `limit` to restrict the number of transactions in the response, and an `offset` to determine where to start.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/loyalty-transactions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "connectionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter transactions by customer Id." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter transactions by customer Id." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter transactions by orderId." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Limit the number of returned results" + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of items to skip before returning results" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LoyaltyApiTransactionsListResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/loyalty-transactions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "items": [ + { + "date": "2023-01-01T12:00:00.00000", + "id": "t101", + "connectionId": "waon-123", + "customerId": "waon-customer-123", + "orderId": "order-123", + "connectionTransactionId": "waonTx1", + "connectionName": "WOAN", + "type": "REDEMPTION", + "value": 200 + } + ], + "total": 54, + "limit": 2, + "offset": 0 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "connectionId": "string", + "customerId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string \\\n -d customerId=string", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "connectionId": "string", + "customerId": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -d connectionId=string \\\n -d customerId=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_loyaltyApi.post_loyalty_transaction": { + "id": "subpackage_loyaltyApi.post_loyalty_transaction", + "namespace": [ + "subpackage_loyaltyApi" + ], + "description": "The Loyalty API is currently in beta.\n\nPlease contact our Support Team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11) for access to the Beta.\nIf you don’t have access, please contact your account administrator for assistance.\n\nNot yet integrated with Primer and interested in learning more? [Contact us](https://primer.io/contact-us/).\n\nCreate an API key with the `loyalty-transactions:write` scopes.\n\nCreate a loyalty transaction. This is either a points redemption or a points refund.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/loyalty-transactions" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "connectionId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the Primer connection configuration." + }, + { + "key": "customerId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + }, + { + "key": "orderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier for the order." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LoyaltyTransactionTypeEnum" + } + }, + "description": "The type of the transaction." + }, + { + "key": "value", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The value of points to redeem." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LoyaltyApiTransactionResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/loyalty-transactions", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connectionId": "string", + "customerId": "string", + "orderId": "string", + "value": 1, + "type": "REDEMPTION" + } + }, + "responseBody": { + "type": "json", + "value": { + "date": "2023-01-01", + "id": "t101", + "connectionId": "waon-123", + "customerId": "waon-customer-123", + "orderId": "order-123", + "connectionTransactionId": "waonTx1", + "connectionName": "WOAN", + "type": "REDEMPTION", + "value": 200 + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connectionId\": \"string\",\n \"customerId\": \"string\",\n \"orderId\": \"string\",\n \"value\": 1,\n \"type\": \"REDEMPTION\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connectionId": "string", + "customerId": "string", + "orderId": "string", + "value": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connectionId\": \"string\",\n \"customerId\": \"string\",\n \"orderId\": \"string\",\n \"value\": 0\n}'", + "generated": true + } + ] + } + }, + { + "path": "/loyalty-transactions", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "connectionId": "string", + "customerId": "string", + "orderId": "string", + "value": 0 + } + }, + "responseBody": { + "type": "json", + "value": { + "error": { + "errorId": "string", + "description": "string", + "diagnosticsId": "string", + "validationErrors": [ + { + "string": {} + } + ] + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/loyalty-transactions \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"connectionId\": \"string\",\n \"customerId\": \"string\",\n \"orderId\": \"string\",\n \"value\": 0\n}'", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_paymentsApi:PaymentCaptureApiRequestOrder": { + "name": "PaymentCaptureApiRequestOrder", + "description": "More information associated with the order.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "retailerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country code of the retailer.\nThis field is passed to the processor and overwrites the retailer country code set in order details." + } + ] + } + }, + "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentCurrencyCode": { + "name": "PaymentsInsightsPatchedPaymentCurrencyCode", + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentStatus": { + "name": "PaymentsInsightsPatchedPaymentStatus", + "description": "See the payment [status table](https://apiref.primer.io/docs#payment-status) for more information.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + }, + { + "value": "FAILED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLED" + }, + { + "value": "PENDING" + } + ] + } + }, + "type_observabilityApiBeta:PaymentsInsightsPatchedPaymentPaymentType": { + "name": "PaymentsInsightsPatchedPaymentPaymentType", + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + }, + { + "value": "MOTO" + }, + { + "value": "IN_STORE" + } + ] + } + }, + "type_:AccountFundingTypeEnum": { + "name": "AccountFundingTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT" + }, + { + "value": "DEBIT" + }, + { + "value": "PREPAID" + }, + { + "value": "CHARGE" + }, + { + "value": "DEFERRED_DEBIT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ApayaCustomerTokenApiSchema": { + "name": "ApayaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mx", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mnc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "mcc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BinDataApiSchema": { + "name": "BinDataApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuerCurrencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + } + }, + { + "key": "regionalRestriction", + "valueShape": { + "type": "id", + "id": "type_:CardRegionRestrictionEnum" + } + }, + { + "key": "accountNumberType", + "valueShape": { + "type": "id", + "id": "type_:CardAccountNumberTypeEnum" + } + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + { + "key": "prepaidReloadableIndicator", + "valueShape": { + "type": "id", + "id": "type_:PrepaidReloadableEnum" + } + }, + { + "key": "productUsageType", + "valueShape": { + "type": "id", + "id": "type_:CardProductTypeEnum" + } + }, + { + "key": "productCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "productName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:BlockingPaymentActionTypeEnum": { + "name": "BlockingPaymentActionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "3DS_AUTHENTICATION" + }, + { + "value": "USE_PRIMER_SDK" + }, + { + "value": "PAYMENT_METHOD_VOUCHER" + }, + { + "value": "PROCESSOR_3DS" + } + ] + } + }, + "type_:CardAccountNumberTypeEnum": { + "name": "CardAccountNumberTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PRIMARY_ACCOUNT_NUMBER" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardNetworkEnum": { + "name": "CardNetworkEnum", + "description": "The list of available card networks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AMEX" + }, + { + "value": "DANKORT" + }, + { + "value": "DINERS_CLUB" + }, + { + "value": "DISCOVER" + }, + { + "value": "ENROUTE" + }, + { + "value": "ELO" + }, + { + "value": "HIPER" + }, + { + "value": "INTERAC" + }, + { + "value": "JCB" + }, + { + "value": "MAESTRO" + }, + { + "value": "MASTERCARD" + }, + { + "value": "MIR" + }, + { + "value": "PRIVATE_LABEL" + }, + { + "value": "UNIONPAY" + }, + { + "value": "VISA" + }, + { + "value": "OTHER" + } + ] + } + }, + "type_:CardProductTypeEnum": { + "name": "CardProductTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CONSUMER" + }, + { + "value": "BUSINESS" + }, + { + "value": "GOVERNMENT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardRegionRestrictionEnum": { + "name": "CardRegionRestrictionEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DOMESTIC_USE_ONLY" + }, + { + "value": "NONE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:OrderDetailsApiSchema": { + "name": "OrderDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "lineItems", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderLineItemsApiSchema" + } + } + }, + "description": "The details of the line items of the order." + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country in which the order is created" + }, + { + "key": "retailerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country code of the retailer" + }, + { + "key": "fees", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderFeesApiSchema" + } + } + }, + "description": "The details of fees charged." + }, + { + "key": "shipping", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderShippingApiSchema" + } + }, + "description": "The details of shipping charged." + } + ] + } + }, + "type_:OrderFeesApiSchema": { + "name": "OrderFeesApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The fee amount charged to the customer, in minor units. e.g. for $7, use `700`." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of fee." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the fee, e.g. \"Currency Conversion Fee\"." + } + ] + } + }, + "type_:OrderLineItemsApiSchema": { + "name": "OrderLineItemsApiSchema", + "description": "The details of the line items of the order.\n\nThe total amount of a line item is calculated like so:\n\n````\n totalAmount = (amount * quantity) - discountAmount + taxAmount\n```\n````", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "itemId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the line item." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A name of the item." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the item." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The amount charged to the customer, in minor units. The minimum amount is 0." + }, + { + "key": "quantity", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of the particular line item that is being ordered." + }, + { + "key": "discountAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Any discount applicable to this item, in minor units. This discount is applied for the entire line item, and not per `quantity`." + }, + { + "key": "taxAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The tax charged on this item, in minor units. This tax amount is applied for the entire line item, and not per `quantity`." + }, + { + "key": "taxCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tax code associated with this item, in minor units. This is required for Primer-initiated tax calculations." + }, + { + "key": "productType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProductTypeEnum" + } + }, + "description": "An identifier for the product type." + }, + { + "key": "productData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderLineItemsProductDataApiSchema" + } + }, + "description": "Details related to the product" + } + ] + } + }, + "type_:OrderLineItemsProductDataApiSchema": { + "name": "OrderLineItemsProductDataApiSchema", + "description": "Details related to the product", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "sku", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product SKU" + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product brand" + }, + { + "key": "color", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product color" + }, + { + "key": "globalTradeItemNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product Global Trade Item Number (e.g. ISBN)" + }, + { + "key": "manufacturerPartNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product Manufacturer Part Number" + }, + { + "key": "weight", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The product weight" + }, + { + "key": "weightUnit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The product weight unit (e.g. kg, g)" + } + ] + } + }, + "type_:OrderShippingApiSchema": { + "name": "OrderShippingApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The shipping amount charged to the customer, in minor units. e.g. for $7, use `700`." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchemaOptions": { + "name": "CheckoutPaymentMethodOptionsApiSchemaOptions", + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionApiSchema" + } + } + }, + { + "key": "PAYMENT_CARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodCardOptionApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchema": { + "name": "CheckoutPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "vaultOn3DS", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted after a successful 3DS authentication or not." + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "orderedAllowedCardNetworks", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + }, + "description": "If provided, the checkout will run the validation on the entered card number and raise an error in case the card network is not supported.\n\nThe order sets the default card network that should be used in the case of co-badged cards.\ne.g. in the case of `[\"VISA\", \"CARTES_BANCAIRES\", \"MASTERCARD\"]` - if the user enters a \"Visa\" / \"Cartes Bancaires\" card: the default is Visa.\n\nValues should be unique.\n\nIf `null` or nothing passed in the request, the following list with all card networks will be returned in the response:\n\n`[\"VISA\", \"MASTERCARD\", \"AMEX\", \"MAESTRO\", \"UNIONPAY\", \"CARTES_BANCAIRES\", \"DANKORT\", \"DINERS_CLUB\", \"DISCOVER\", \"ENROUTE\", \"ELO\", \"HIPER\", \"INTERAC\", \"JCB\", \"MIR\", \"OTHER\"]`" + }, + { + "key": "options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchemaOptions" + } + }, + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options." + }, + { + "key": "authorizationType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AuthorizationTypeEnum" + } + }, + "description": "Allows to adjust the authorized amount after the authorization, if supported by payment method.\n`FINAL` - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount.\n`ESTIMATED` - the amount can be adjusted after the authorization, if supported by payment method." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionApiSchema": { + "name": "CheckoutPaymentMethodOptionApiSchema", + "description": "Options for the payment method of type `PAYMENT_METHOD_TYPE`.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + }, + "description": "Surcharge information" + } + ] + } + }, + "type_:CheckoutPaymentMethodCardOptionApiSchema": { + "name": "CheckoutPaymentMethodCardOptionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "networks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema" + } + }, + "description": "Dictionary of available card networks as a key with value of Payment Method Card Network Option." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "AMEX", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DANKORT", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DINERS_CLUB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DISCOVER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ENROUTE", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ELO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "HIPER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "INTERAC", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "JCB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MAESTRO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MASTERCARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MIR", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "PRIVATE_LABEL", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "UNIONPAY", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "VISA", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "OTHER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + } + }, + "description": "Surcharge information" + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated." + } + ] + } + }, + "type_:PaymentRequestPaymentMethodOptionsApiSchema": { + "name": "PaymentRequestPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "vaultOn3DS", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted after a successful 3DS authentication or not." + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "authorizationType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AuthorizationTypeEnum" + } + }, + "description": "Allows to adjust the authorized amount after the authorization, if supported by payment method.\n`FINAL` - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount.\n`ESTIMATED` - the amount can be adjusted after the authorization, if supported by payment method.\nDefaults to `FINAL`." + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData": { + "name": "PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Order Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalOrderTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Payment Session Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaPaymentSessionApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Ideal Pay Nl Token Api Schema", + "shape": { + "type": "id", + "id": "type_:IdealPayNlTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchema": { + "name": "PaymentResponsePaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the payment, as it would typically appear\non a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringPaymentTypeSchema" + } + } + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment method token used to authorize the transaction." + }, + { + "key": "isVaulted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method token represents a vaulted payment method and can be used for future payments." + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type used for payment authorization." + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchema" + } + } + }, + { + "key": "authorizationType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AuthorizationTypeEnum" + } + }, + "description": "Allows to adjust the authorized amount after the authorization, if supported by payment method. `FINAL` - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount. `ESTIMATED` - the amount can be adjusted after the authorization, if supported by payment method." + } + ] + } + }, + "type_:CheckoutCustomerDetailsApiSchema": { + "name": "CheckoutCustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.
Must be a valid email address. Supports internationalized email addresses." + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer billing address." + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:CustomerDetailsApiSchema": { + "name": "CustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer billing address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OptionalAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:ClientSessionWithTokenApiResponse": { + "name": "ClientSessionWithTokenApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token used to initialize the SDK on all platforms." + }, + { + "key": "clientTokenExpirationDate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Expiration date & time of the client token (UTC with no timezoneinfo)." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment methods." + }, + { + "key": "warnings", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ClientSessionWarningsApiResponse" + } + }, + "description": "Warning messages to indicate missing information that are required for payment methods, checkout modules and other features; or when third-party services are unavailable." + } + ] + } + }, + "type_:ClientSessionApiResponse": { + "name": "ClientSessionApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you are going to charge the customer, in minor units. This amount is calculated from the line items, shipping and other amounts provided in the `order`.\nIf a top-level amount is provided, it would override any calculated amount." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment methods." + } + ] + } + }, + "type_:ClientSessionWarningsApiResponse": { + "name": "ClientSessionWarningsApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the connection involved" + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique code describing the particular issue" + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "More information as to the reason for the warning" + } + ] + } + }, + "type_:CountryCodeEnum": { + "name": "CountryCodeEnum", + "description": "2-letter country code in ISO 3166-1 alpha format,\ne.g. FR for France and GB for the United Kingdom.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:Currency": { + "name": "Currency", + "description": "3-letter currency code in ISO 4217 format,\ne.g. USD for US dollars.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentResponseProcessorApiSchema": { + "name": "PaymentResponseProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + }, + { + "key": "amountCaptured", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no capture was performed, this value will be set to `0`.\n\nIf one or more partial captures were performed, this value will be a sum\nof all partial capture amounts." + }, + { + "key": "amountRefunded", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no refund was performed, this value will be set to `0`.\n\nIf one or more partial refunds were performed, this value will be a sum\nof all partial refund amounts." + } + ] + } + }, + "type_:GoCardlessMandateApiSchema": { + "name": "GoCardlessMandateApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gocardlessMandateId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of a GoCardless mandate agreement" + } + ] + } + }, + "type_:IdealPayNlTokenApiSchema": { + "name": "IdealPayNlTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodConfigId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:KlarnaAddressApiSchema": { + "name": "KlarnaAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "phoneNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine3", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:KlarnaCustomerTokenApiSchema": { + "name": "KlarnaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaCustomerToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaPaymentSessionApiSchema": { + "name": "KlarnaPaymentSessionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaAuthorizationToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaSessionDetailsApiSchema": { + "name": "KlarnaSessionDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "recurringDescription", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "billingAddress", + "valueShape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + } + }, + { + "key": "purchaseCountry", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "purchaseCurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "locale", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "orderLines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "key": "tokenDetails", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaTokenDetails" + } + } + } + ] + } + }, + "type_:KlarnaTokenDetails": { + "name": "KlarnaTokenDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "masked_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiry_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalBillingAgreementApiSchema": { + "name": "PayPalBillingAgreementApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalBillingAgreementId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddressApiSchema" + } + }, + "description": "The PayPal customer's shipping address" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalExternalPayerInfoApiSchema": { + "name": "PayPalExternalPayerInfoApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalPayerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalOrderTokenApiSchema": { + "name": "PayPalOrderTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalOrderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentApiResponse": { + "name": "PaymentApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "dateUpdated", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time of the last payment update in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "cardTokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardTokenTypeEnum" + } + }, + "description": "The type of card token used for the payment.\n\nOnly applies for card payments." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "requiredAction", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequiredActionApiSchema" + } + }, + "description": "Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\n\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + }, + { + "key": "riskData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskDataApiSchema" + } + } + } + ] + } + }, + "type_:PaymentCardTokenApiSchema": { + "name": "PaymentCardTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "isNetworkTokenized", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BinDataApiSchema" + } + } + } + ] + } + }, + "type_:StatusReasonApiSchema": { + "name": "StatusReasonApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatusTypeEnum" + }, + "description": "Type of the status." + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeclineTypeEnum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED` this will be returned.\n\nDeclines of type `SOFT_DECLINE` may be retried,\nwhereas declines of type `HARD_DECLINE` should not be retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionDeclineReasonV2Enum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED`, this will be returned." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "In case of an error on the processor's part, we will return the message returned by the processor. This is usually a human readable error." + } + ] + } + }, + "type_:RiskDataApiSchema": { + "name": "RiskDataApiSchema", + "description": "Risk data associated with this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fraudChecks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudCheckApiSchema" + } + } + }, + { + "key": "cvvCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CvvCheckApiSchema" + } + } + }, + { + "key": "avsCheck", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsCheckApiSchema" + } + } + } + ] + } + }, + "type_:FraudCheckApiSchema": { + "name": "FraudCheckApiSchema", + "description": "Results of the pre-authorization and post-authorization fraud checks.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "preAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + }, + { + "key": "postAuthorizationResult", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FraudDecisionTypeEnum" + } + } + } + ] + } + }, + "type_:FraudDecisionTypeEnum": { + "name": "FraudDecisionTypeEnum", + "description": "Possible fraud check outcomes.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ACCEPT" + }, + { + "value": "REFUSE" + }, + { + "value": "FAILED" + }, + { + "value": "THREE_DS" + } + ] + } + }, + "type_:CvvCheckApiSchema": { + "name": "CvvCheckApiSchema", + "description": "Results of any external CVV check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:AvsCheckApiSchema": { + "name": "AvsCheckApiSchema", + "description": "Results of any external AVS check performed on this payment.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AvsRiskAssessmentValues" + } + } + } + ] + } + }, + "type_:AvsRiskAssessmentValues": { + "name": "AvsRiskAssessmentValues", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "streetAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RiskAssessmentStatusEnum" + } + } + } + ] + } + }, + "type_:RiskAssessmentStatusEnum": { + "name": "RiskAssessmentStatusEnum", + "description": "Possible risk assessment values for CVV and AVS checks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MATCHED" + }, + { + "value": "NOT_MATCHED" + }, + { + "value": "NOT_VERIFIED" + }, + { + "value": "NOT_PROVIDED" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "SKIPPED" + } + ] + } + }, + "type_:PaymentMethodTypeEnum": { + "name": "PaymentMethodTypeEnum", + "description": "Payment method type, where `OFF_SESSION_PAYMENT` is used for APM (Alternative Payment Method) payments and `PAYMENT_CARD` for traditional debit or credit cards. Please note that this list is different from one indicated on [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) page and values of this field will be changed in the future versions of the API.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PAYMENT_CARD" + }, + { + "value": "GOOGLE_PAY" + }, + { + "value": "APPLE_PAY" + }, + { + "value": "PAYPAL" + }, + { + "value": "BANK_ACCOUNT" + }, + { + "value": "KLARNA" + }, + { + "value": "APAYA" + }, + { + "value": "OPENNODE" + }, + { + "value": "HOOLAH" + }, + { + "value": "ATOME" + }, + { + "value": "COINBASE" + }, + { + "value": "NETS" + }, + { + "value": "TWOC2P" + }, + { + "value": "CLEARPAY" + }, + { + "value": "SHOPEEPAY" + }, + { + "value": "TRIPLE_A" + }, + { + "value": "AFTERPAY" + }, + { + "value": "NOL_PAY" + }, + { + "value": "PAY_NL_IDEAL" + }, + { + "value": "PAY_NL_BANCONTACT" + }, + { + "value": "PAY_NL_DIRECT_DEBIT" + }, + { + "value": "PAY_NL_SOFORT_BANKING" + }, + { + "value": "PAY_NL_PAYPAL" + }, + { + "value": "PAY_NL_PAYCONIQ" + }, + { + "value": "PAY_NL_GIROPAY" + }, + { + "value": "PAY_NL_P24" + }, + { + "value": "PAY_NL_EPS" + }, + { + "value": "PAY_NL_KAARTDIRECT" + }, + { + "value": "ADYEN_SOFORT" + }, + { + "value": "ADYEN_TWINT" + }, + { + "value": "ADYEN_GIROPAY" + }, + { + "value": "ADYEN_TRUSTLY" + }, + { + "value": "ADYEN_ALIPAY" + }, + { + "value": "ADYEN_MOBILEPAY" + }, + { + "value": "ADYEN_MULTIBANCO" + }, + { + "value": "ADYEN_VIPPS" + }, + { + "value": "ADYEN_DOTPAY" + }, + { + "value": "ADYEN_IDEAL" + }, + { + "value": "ADYEN_BLIK" + }, + { + "value": "ADYEN_PAYTRAIL" + }, + { + "value": "ADYEN_INTERAC" + }, + { + "value": "ADYEN_PAYSHOP" + }, + { + "value": "ADYEN_MBWAY" + }, + { + "value": "ADYEN_AFFIRM" + }, + { + "value": "ADYEN_KLARNA" + }, + { + "value": "ADYEN_BANCONTACT_PAYCONIQ" + }, + { + "value": "ADYEN_EPS" + }, + { + "value": "ADYEN_BANCONTACT_CARD" + }, + { + "value": "ADYEN_SWISH" + }, + { + "value": "MOLLIE_IDEAL" + }, + { + "value": "MOLLIE_BANCONTACT" + }, + { + "value": "MOLLIE_P24" + }, + { + "value": "MOLLIE_GIROPAY" + }, + { + "value": "MOLLIE_EPS" + }, + { + "value": "MOLLIE_GIFTCARD" + }, + { + "value": "MOLLIE_SOFORT" + }, + { + "value": "NETAXEPT_PAYTRAIL" + }, + { + "value": "BUCKAROO_IDEAL" + }, + { + "value": "BUCKAROO_BANCONTACT" + }, + { + "value": "BUCKAROO_SOFORT" + }, + { + "value": "BUCKAROO_GIROPAY" + }, + { + "value": "BUCKAROO_EPS" + }, + { + "value": "RAPYD_GCASH" + }, + { + "value": "RAPYD_PROMPTPAY" + }, + { + "value": "RAPYD_GRABPAY" + }, + { + "value": "RAPYD_POLI" + }, + { + "value": "RAPYD_FAST" + }, + { + "value": "XFERS_PAYNOW" + }, + { + "value": "STRIPE_GIROPAY" + }, + { + "value": "STRIPE_IDEAL" + }, + { + "value": "ALIPAY_CN" + }, + { + "value": "CHAI_KAKAOPAY" + }, + { + "value": "CHAI_NAVER" + }, + { + "value": "CHAI_TOSS" + }, + { + "value": "XENDIT_DANA" + }, + { + "value": "XENDIT_OVO" + }, + { + "value": "XENDIT_SHOPEEPAY" + }, + { + "value": "XENDIT_RETAIL_OUTLETS" + }, + { + "value": "OMISE_PROMPTPAY" + }, + { + "value": "OMISE_TRUEMONEY" + }, + { + "value": "EBANX_PAGOFACIL" + }, + { + "value": "PACYPAY_WECHAT" + }, + { + "value": "PACYPAY_ALIPAY" + }, + { + "value": "PACYPAY_ALIPAY_PLUS" + }, + { + "value": "WORLDPAY_IDEAL" + }, + { + "value": "IPAY88_CARD" + }, + { + "value": "INGENICO_PAYPAL" + }, + { + "value": "VOLT_PIX" + }, + { + "value": "VOLT_BANK_TRANSFER" + }, + { + "value": "BRAINTREE_VENMO" + }, + { + "value": "THUNES_SPIRIT_OF_CADEAU" + }, + { + "value": "THUNES_ILLICADO" + }, + { + "value": "THUNES_CARTE_CADEAU_CONFORAMA" + }, + { + "value": "THUNES_CHEQUE_FIDELITE_CONFORAMA" + }, + { + "value": "SIPS_CPAY" + }, + { + "value": "SIPS_CPAYCONFORAMA" + }, + { + "value": "MONEXT_CETELEM" + }, + { + "value": "MONEXT_CPAY" + } + ] + } + }, + "type_:PaymentListApiResponse": { + "name": "PaymentListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PaymentSummaryApiSchema" + } + } + } + }, + { + "key": "nextCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "prevCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentRequiredActionApiSchema": { + "name": "PaymentRequiredActionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:BlockingPaymentActionTypeEnum" + }, + "description": "Action name" + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Human description of the required action to perform." + }, + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The client token to be returned to the SDK if a required action is returned." + } + ] + } + }, + "type_:PaymentSummaryApiSchema": { + "name": "PaymentSummaryApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "dateUpdated", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The date and time of the last payment update in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatus" + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Your reference for the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentSummaryProcessorApiSchema" + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The payment amount, in minor units. e.g. $7 would show as `700`." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`" + } + ] + } + }, + "type_:PaymentAuthorizationRequestProcessorApiSchema": { + "name": "PaymentAuthorizationRequestProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The processor's merchant ID used to authorize the payment." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The processor name should be provided if the processorMerchantId is not unique across all of your integrations." + } + ] + } + }, + "type_:PaymentSummaryProcessorApiSchema": { + "name": "PaymentSummaryProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + } + ] + } + }, + "type_:PrepaidReloadableEnum": { + "name": "PrepaidReloadableEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RELOADABLE" + }, + { + "value": "NON_RELOADABLE" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:RecurringTransactionTypeEnum": { + "name": "RecurringTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + } + ] + } + }, + "type_:RecurringPaymentTypeSchema": { + "name": "RecurringPaymentTypeSchema", + "description": "Payment types, primarily to be used for recurring payments.\nNote: If you successfully vault a `SINGLE_USE` token on payment creation, then there's no need to set a value for this field and it will be flagged as `FIRST_PAYMENT`. In all other cases, this field will default to `ECOMMERCE`, unless you set the field explicitly. See the table below for all possible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:RecurringTransactionTypeEnum" + } + } + }, + "type_:ProductTypeEnum": { + "name": "ProductTypeEnum", + "description": "An enumeration", + "shape": { + "type": "enum", + "values": [ + { + "value": "PHYSICAL" + }, + { + "value": "DIGITAL" + } + ] + } + }, + "type_:ThreeDSecureAuthResponseCodeEnum": { + "name": "ThreeDSecureAuthResponseCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchemaReasonCode": { + "name": "ThreeDSecureAuthenticationApiSchemaReasonCode", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Three D Secure Skipped Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureSkippedReasonCodeEnum" + } + }, + { + "displayName": "Three D Secure Failed Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureFailedReasonCodeEnum" + } + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchema": { + "name": "ThreeDSecureAuthenticationApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "responseCode", + "valueShape": { + "type": "id", + "id": "type_:ThreeDSecureAuthResponseCodeEnum" + } + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchemaReasonCode" + } + } + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ThreeDSecureFailedReasonCodeEnum": { + "name": "ThreeDSecureFailedReasonCodeEnum", + "description": "This enum is derived from the `transStatusReason` on page 218 of the\n[EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/uploads/documents/EMVCo_3DS_Spec_v220_122018.pdf)\n\n| Code | Description |\n| ---- | --------------------------------------- |\n| 01 | Card authentication failed |\n| 02 | Unknown Device |\n| 03 | Unsupported Device |\n| 04 | Exceeds authentication frequency limit |\n| 05 | Expired card |\n| 06 | Invalid card number |\n| 07 | Invalid transaction |\n| 08 | No Card record |\n| 09 | Security failure |\n| 10 | Stolen card |\n| 11 | Suspected fraud |\n| 12 | Transaction not permitted to cardholder |\n| 13 | Cardholder not enrolled in service |\n| 14 | Transaction timed out at the ACS |\n| 15 | Low confidence |\n| 16 | Medium confidence |", + "shape": { + "type": "enum", + "values": [ + { + "value": "UNKNOWN" + }, + { + "value": "REJECTED_BY_ISSUER" + }, + { + "value": "CARD_AUTHENTICATION_FAILED" + }, + { + "value": "UNKNOWN_DEVICE" + }, + { + "value": "UNSUPPORTED_DEVICE" + }, + { + "value": "EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "INVALID_TRANSACTION" + }, + { + "value": "NO_CARD_RECORD" + }, + { + "value": "SECURITY_FAILURE" + }, + { + "value": "STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER" + }, + { + "value": "CARDHOLDER_NOT_ENROLLED_IN_SERVICE" + }, + { + "value": "TRANSACTION_TIMED_OUT_AT_THE_ACS" + }, + { + "value": "LOW_CONFIDENCE" + }, + { + "value": "MEDIUM_CONFIDENCE" + }, + { + "value": "HIGH_CONFIDENCE" + }, + { + "value": "VERY_HIGH_CONFIDENCE" + }, + { + "value": "EXCEEDS_ACS_MAXIMUM_CHALLENGES" + }, + { + "value": "NON_PAYMENT_NOT_SUPPORTED" + }, + { + "value": "THREE_RI_NOT_SUPPORTED" + }, + { + "value": "ACS_TECHNICAL_ISSUE" + }, + { + "value": "DECOUPLED_REQUIRED_BY_ACS" + }, + { + "value": "DECOUPLED_MAX_EXPIRY_EXCEEDED" + }, + { + "value": "DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME" + }, + { + "value": "AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER" + }, + { + "value": "ACS_TIMED_OUT" + }, + { + "value": "INVALID_ACS_RESPONSE" + }, + { + "value": "ACS_SYSTEM_ERROR_RESPONSE" + }, + { + "value": "ERROR_GENERATING_CAVV" + }, + { + "value": "PROTOCOL_VERSION_NOT_SUPPORTED" + }, + { + "value": "TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING" + }, + { + "value": "REQUESTED_PROGRAM_NOT_SUPPORTED" + } + ] + } + }, + "type_:ThreeDSecureSkippedReasonCodeEnum": { + "name": "ThreeDSecureSkippedReasonCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "GATEWAY_UNAVAILABLE" + }, + { + "value": "DISABLED_BY_MERCHANT" + }, + { + "value": "NOT_SUPPORTED_BY_ISSUER" + }, + { + "value": "FAILED_TO_NEGOTIATE" + }, + { + "value": "UNKNOWN_ACS_RESPONSE" + }, + { + "value": "3DS_SERVER_ERROR" + }, + { + "value": "ACQUIRER_NOT_CONFIGURED" + }, + { + "value": "ACQUIRER_NOT_PARTICIPATING" + } + ] + } + }, + "type_:TokenTypeEnum": { + "name": "TokenTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MULTI_USE" + }, + { + "value": "SINGLE_USE" + } + ] + } + }, + "type_:DeclineTypeEnum": { + "name": "DeclineTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:TransactionDeclineReasonV2Enum": { + "name": "TransactionDeclineReasonV2Enum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:TransactionOverviewApiSchema": { + "name": "TransactionOverviewApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Date & time of the transaction (UTC)" + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Transaction amount in minor units" + }, + { + "key": "currencyCode", + "valueShape": { + "type": "id", + "id": "type_:Currency" + }, + "description": "The 3-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The reference submitted on payment creation or refund." + }, + { + "key": "transactionType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionTypeEnum" + } + } + }, + { + "key": "processorTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Processor's unique identifier for the transaction" + }, + { + "key": "processorName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier of a processor." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Processor's main account identifier.\n\n- Adyen: Account code\n- Braintree: Merchant ID\n- Stripe: Account ID\"" + }, + { + "key": "processorStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Transaction status, please refer to the [Transaction Status Codes](#section/API-Usage-Guide/Payment-Status) table for more information" + }, + { + "key": "processorStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "If the transaction has a declined or failed status.\n\nOnly if the status is `DECLINED` or `FAILED`, otherwise `null`." + }, + { + "key": "cardTokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardTokenTypeEnum" + } + }, + "description": "The type of card token used for the payment.\n\nOnly applies for card payments." + } + ] + } + }, + "type_:PaymentStatus": { + "name": "PaymentStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "FAILED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "SETTLED" + }, + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + } + ] + } + }, + "type_:PaymentStatusTypeEnum": { + "name": "PaymentStatusTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:TransactionTypeEnum": { + "name": "TransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SALE" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:OptionalAddressApiSchema": { + "name": "OptionalAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:AddressApiSchema": { + "name": "AddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "id", + "id": "type_:CountryCodeEnum" + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData": { + "name": "MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponse": { + "name": "MerchantPaymentMethodTokenApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Creation date & time of the object (UTC)" + }, + { + "key": "deletedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date & time when this object was revoked. (UTC)" + }, + { + "key": "deleted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this object has been revoked." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The vaulted payment method token." + }, + { + "key": "tokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "- `MULTI_USE` a vaulted token that can be re-used with subsequent payments" + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type associated with a token." + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID representing the customer" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A friendly description given by the user" + }, + { + "key": "default", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this payment method is the default" + } + ] + } + }, + "type_:VerifiedMerchantPaymentMethodTokenApiResponse": { + "name": "VerifiedMerchantPaymentMethodTokenApiResponse", + "shape": { + "type": "object", + "extends": [ + "type_:MerchantPaymentMethodTokenApiResponse" + ], + "properties": [ + { + "key": "isVerified", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this payment method was verified" + } + ] + } + }, + "type_:VerifiedMerchantPaymentMethodTokenListApiResponse": { + "name": "VerifiedMerchantPaymentMethodTokenListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VerifiedMerchantPaymentMethodTokenApiResponse" + } + } + } + } + ] + } + }, + "type_:LoyaltyApiBalanceResponse": { + "name": "LoyaltyApiBalanceResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + }, + { + "key": "connectionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the Primer connection configuration." + }, + { + "key": "connectionName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the loyalty provider." + }, + { + "key": "balance", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The loyalty customer's points balance." + } + ] + } + }, + "type_:LoyaltyTransactionTypeEnum": { + "name": "LoyaltyTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "REDEMPTION" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:LoyaltyApiTransactionResponse": { + "name": "LoyaltyApiTransactionResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Creation date & time of the transaction (UTC)" + }, + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique Primer identifier for the loyalty transaction." + }, + { + "key": "connectionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the Primer connection configuration." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the customer on the loyalty provider." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique identifier for the order." + }, + { + "key": "connectionTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the transaction on the loyalty provider's side." + }, + { + "key": "connectionName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the loyalty provider." + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LoyaltyTransactionTypeEnum" + } + }, + "description": "The type of the transaction." + }, + { + "key": "value", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The value of the transaction." + } + ] + } + }, + "type_:LoyaltyApiTransactionsListResponse": { + "name": "LoyaltyApiTransactionsListResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "items", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:LoyaltyApiTransactionResponse" + } + } + }, + "description": "The list of loyalty transactions" + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of available results" + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The limit of the paged result" + }, + { + "key": "offset", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The offset of the paged result" + } + ] + } + }, + "type_:PaymentsInsightsBinDataIssuerCountryCode": { + "name": "PaymentsInsightsBinDataIssuerCountryCode", + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:PaymentsInsightsBinData": { + "name": "PaymentsInsightsBinData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsBinDataIssuerCountryCode" + } + }, + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom." + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the issuing bank." + }, + { + "key": "productUsageType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The usage type of the payment card e.g. commercial, consumer." + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The funding type of the payment card e.g. credit, debit, prepaid." + } + ] + } + }, + "type_:PaymentsInsightsOrderCountryCode": { + "name": "PaymentsInsightsOrderCountryCode", + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:PaymentsInsightsOrder": { + "name": "PaymentsInsightsOrder", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The order reference for the payment." + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsOrderCountryCode" + } + }, + "description": "2-letter country code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) alpha format,\ne.g. FR for France and GB for the United Kingdom." + } + ] + } + }, + "type_:PaymentsInsightsPaymentCurrencyCode": { + "name": "PaymentsInsightsPaymentCurrencyCode", + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentsInsightsPaymentStatus": { + "name": "PaymentsInsightsPaymentStatus", + "description": "See the payment [status table](https://apiref.primer.io/docs#payment-status) for more information.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + }, + { + "value": "FAILED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLED" + }, + { + "value": "PENDING" + } + ] + } + }, + "type_:PaymentsInsightsPaymentPaymentType": { + "name": "PaymentsInsightsPaymentPaymentType", + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + }, + { + "value": "MOTO" + }, + { + "value": "IN_STORE" + } + ] + } + }, + "type_:PaymentsInsightsPayment": { + "name": "PaymentsInsightsPayment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment ID.\n\nThe payment ID must be unique. You can use this unique payment ID to update payment details." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentCurrencyCode" + }, + "description": "The 3-letter currency code in\n[ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\n\ne.g. use `USD` for US dollars." + }, + { + "key": "processor", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsProcessor" + } + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The amount you would like to charge the customer,\nin minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units.\nIn this case you should use the value as it is, without any formatting.\nFor example for ¥100, use `100`.\nThe minimum amount is 0." + }, + { + "key": "createdAt", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The payment creation date and time (UTC) in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).\n\nCannot be updated in partial updates PATCH." + }, + { + "key": "order", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsOrder" + } + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentStatus" + } + }, + "description": "See the payment [status table](https://apiref.primer.io/docs#payment-status) for more information." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReason" + } + }, + "description": "Pass more information regarding the payment's status in this field.\n\nThis is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentMethod" + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nAd dictionary of key-value pairs where the values can only be strings or integers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"88278a\"}`" + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentPaymentType" + } + }, + "description": "Payment types, primarily to be used for recurring payments.\n\nNote: If you successfully vault a `SINGLE_USE` token on payment\ncreation, then there's no need to set a value for this field and it will\nbe flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all\npossible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |\n| `MOTO` | a merchant-initiated mail order or telephone order payment. |\n| `IN_STORE` | a customer-initiated payment where the customer is physically present in a shop. |" + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment,\nas it would typically appear on a bank statement." + } + ] + } + }, + "type_:PaymentsInsightsPaymentMethod": { + "name": "PaymentsInsightsPaymentMethod", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodType", + "valueShape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + }, + "description": "Payment method type used for payment authorization." + }, + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsPaymentMethodData" + } + } + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsThreeDSecureAuthentication" + } + } + } + ] + } + }, + "type_:PaymentsInsightsPaymentMethodData": { + "name": "PaymentsInsightsPaymentMethodData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsBinData" + } + } + }, + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The first six digits of the card used for payment,\nalso known as the Bank Identification Number (BIN)." + } + ] + } + }, + "type_:PaymentsInsightsProcessorName": { + "name": "PaymentsInsightsProcessorName", + "description": "The payment processor used for this payment.\nPrimer supports the above processors through the Payments API,\nhowever any value can be passed here.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APAYA" + }, + { + "value": "ADYEN" + }, + { + "value": "AFTERPAY" + }, + { + "value": "AIRWALLEX" + }, + { + "value": "ALIANT" + }, + { + "value": "ALIPAY" + }, + { + "value": "ATOME" + }, + { + "value": "BANKED" + }, + { + "value": "BARCLAYCARD" + }, + { + "value": "BRAINTREE" + }, + { + "value": "BUCKAROO" + }, + { + "value": "BRIDGE" + }, + { + "value": "CHAI" + }, + { + "value": "CHECKOUT" + }, + { + "value": "CLEARPAY" + }, + { + "value": "COINBASE" + }, + { + "value": "CYBERSOURCE" + }, + { + "value": "DLOCAL" + }, + { + "value": "EBANX" + }, + { + "value": "ECOSPEND" + }, + { + "value": "FINTECTURE" + }, + { + "value": "GLOBAL_PAYMENTS" + }, + { + "value": "HOOLAH" + }, + { + "value": "INGENICO" + }, + { + "value": "INGENICO-CONNECT" + }, + { + "value": "KLARNA" + }, + { + "value": "LAYBUY" + }, + { + "value": "MPGS" + }, + { + "value": "MOLLIE" + }, + { + "value": "NEONOMICS" + }, + { + "value": "NEXI" + }, + { + "value": "NUVEI" + }, + { + "value": "OMISE" + }, + { + "value": "OPENNODE" + }, + { + "value": "PAY_NL" + }, + { + "value": "PAY-NL" + }, + { + "value": "PAYGENT" + }, + { + "value": "PAYPAL" + }, + { + "value": "PRIMER_TEST" + }, + { + "value": "STRIPE" + }, + { + "value": "TRILO" + }, + { + "value": "TRUELAYER" + }, + { + "value": "VOLT" + }, + { + "value": "VYNE" + }, + { + "value": "WORLDPAY" + }, + { + "value": "EMERCHANTPAY" + }, + { + "value": "XFERS" + }, + { + "value": "RAPYD" + }, + { + "value": "AUTHNET" + }, + { + "value": "NETS" + }, + { + "value": "NETAXEPT" + }, + { + "value": "PRIMER_PROCESSOR" + }, + { + "value": "REACH" + }, + { + "value": "TRUST_PAYMENTS" + }, + { + "value": "TWOC2P" + }, + { + "value": "MERCADO_PAGO" + }, + { + "value": "PAYU" + }, + { + "value": "XENDIT" + }, + { + "value": "FISERV" + }, + { + "value": "PACYPAY" + }, + { + "value": "SHOPEEPAY" + }, + { + "value": "TRIPLE_A" + }, + { + "value": "IPAY88" + }, + { + "value": "APPLE_PAY" + }, + { + "value": "GOOGLE_PAY" + }, + { + "value": "RISKIFIED" + }, + { + "value": "TAXJAR" + }, + { + "value": "STITCH" + }, + { + "value": "SIGNIFYD" + } + ] + } + }, + "type_:PaymentsInsightsProcessor": { + "name": "PaymentsInsightsProcessor", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:PaymentsInsightsProcessorName" + }, + "description": "The payment processor used for this payment.\nPrimer supports the above processors through the Payments API,\nhowever any value can be passed here." + }, + { + "key": "merchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + } + ] + } + }, + "type_:PaymentsInsightsStatusReasonType": { + "name": "PaymentsInsightsStatusReasonType", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:PaymentsInsightsStatusReasonDeclineType": { + "name": "PaymentsInsightsStatusReasonDeclineType", + "description": "Declines of type `SOFT_DECLINE` may have been retried.\nWhereas declines of type `HARD_DECLINE` should have not been retried.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:PaymentsInsightsStatusReasonCode": { + "name": "PaymentsInsightsStatusReasonCode", + "description": "Payment status code with the error code when\nthe issuer declined the payment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:PaymentsInsightsStatusReason": { + "name": "PaymentsInsightsStatusReason", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReasonType" + } + } + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReasonDeclineType" + } + }, + "description": "Declines of type `SOFT_DECLINE` may have been retried.\nWhereas declines of type `HARD_DECLINE` should have not been retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsStatusReasonCode" + } + }, + "description": "Payment status code with the error code when\nthe issuer declined the payment." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Message detail returned by the processor when\nthe error on appeared on their part." + } + ] + } + }, + "type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode": { + "name": "PaymentsInsightsThreeDSecureAuthenticationResponseCode", + "description": "The response returned during the 3D Secure authentication call.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:PaymentsInsightsThreeDSecureAuthentication": { + "name": "PaymentsInsightsThreeDSecureAuthentication", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "transStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "transStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "responseCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentsInsightsThreeDSecureAuthenticationResponseCode" + } + }, + "description": "The response returned during the 3D Secure authentication call." + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "The challenge status of the 3D Secure authentication.\nSet to false for frictionless 3D Secure authentication." + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The protocol version used during 3D Secure authentication." + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The reason code for unsuccessful 3D Secure authentication attempts." + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The human readable reason text for unsuccessful\n3D Secure authentication attempts." + }, + { + "key": "eci", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "E-commerce Indicator (ECI)" + } + ] + } + }, + "type_:ErrorObject": { + "name": "ErrorObject", + "description": "An object containing information about the error that occurred.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "errorId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An error ID" + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A human readable description of the error" + }, + { + "key": "diagnosticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An ID that you can quote when contacting the Primer support team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11)." + }, + { + "key": "validationErrors", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "description": "Returned in case of a badly formed request" + } + ] + } + }, + "type_:four_hundred_ErrorResponse": { + "name": "four_hundred_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:ErrorObject" + } + } + ] + } + }, + "type_:four_hundred_four_ErrorResponse": { + "name": "four_hundred_four_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:ErrorObject" + } + } + ] + } + }, + "type_:four_hundred_nine_ErrorResponseError": { + "name": "four_hundred_nine_ErrorResponseError", + "shape": { + "type": "object", + "extends": [ + "type_:ErrorObject" + ], + "properties": [ + { + "key": "paymentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Payment ID of the related payment" + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Status of the related payment" + } + ] + } + }, + "type_:four_hundred_nine_ErrorResponse": { + "name": "four_hundred_nine_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:four_hundred_nine_ErrorResponseError" + } + } + ] + } + }, + "type_:four_hundred_twenty_two_ErrorResponse": { + "name": "four_hundred_twenty_two_ErrorResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "id", + "id": "type_:ErrorObject" + } + } + ] + } + }, + "type_:AuthorizationTypeEnum": { + "name": "AuthorizationTypeEnum", + "description": "Type of authorization for the payment.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ESTIMATED" + }, + { + "value": "FINAL" + } + ] + } + }, + "type_:CardTokenTypeEnum": { + "name": "CardTokenTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CARD_PAN" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "PROCESSOR_TOKEN" + } + ] + } + } + }, + "subpackages": { + "subpackage_clientSessionApi": { + "id": "subpackage_clientSessionApi", + "name": "Client Session API" + }, + "subpackage_paymentsApi": { + "id": "subpackage_paymentsApi", + "name": "Payments API" + }, + "subpackage_paymentMethodsApi": { + "id": "subpackage_paymentMethodsApi", + "name": "Payment Methods API" + }, + "subpackage_observabilityApiBeta": { + "id": "subpackage_observabilityApiBeta", + "name": "Observability API (beta)" + }, + "subpackage_loyaltyApi": { + "id": "subpackage_loyaltyApi", + "name": "Loyalty API" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-API-KEY", + "nameOverride": "apiKey" + } + } + }, + { + "id": "fe590ab9-f9e7-4719-8ec5-b595affff88d", + "endpoints": { + "subpackage_clientSessionApi.createClientSideToken": { + "id": "subpackage_clientSessionApi.createClientSideToken", + "namespace": [ + "subpackage_clientSessionApi" + ], + "description": "Creating a client session generates a client token: a temporary key used to initialize [Universal Checkout](https://primer.io/docs/accept-payments/setup-universal-checkout/installation/web) and authenticate it against your account.\n\nUniversal Checkout automatically retrieves all the settings from the client session and the Dashboard to configure the payment methods and the checkout experience.\n\nNote:\nWhen creating a Client Session, please make sure to provide `currencyCode`, `orderId`, and `amount`.\nIf any of these are not yet available, you can provide them when making the payment request.\n\nClient tokens expire after 24 hours.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/client-session" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The three-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). e.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`.\n\nIf the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nCreate a client session token with a customer ID to enable the client-side SDK to retrieve and manage your customer's saved payment methods." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ClientSessionApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/client-session", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + } + } + } + }, + "responseBody": { + "type": "json", + "value": { + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "options": { + "": { + "surcharge": {} + }, + "PAYMENT_CARD": { + "networks": { + "AMEX": { + "surcharge": {} + }, + "DANKORT": { + "surcharge": {} + }, + "DINERS_CLUB": { + "surcharge": {} + }, + "DISCOVER": { + "surcharge": {} + }, + "ENROUTE": { + "surcharge": {} + }, + "ELO": { + "surcharge": {} + }, + "HIPER": { + "surcharge": {} + }, + "INTERAC": { + "surcharge": {} + }, + "JCB": { + "surcharge": {} + }, + "MAESTRO": { + "surcharge": {} + }, + "MASTERCARD": { + "surcharge": {} + }, + "MIR": { + "surcharge": {} + }, + "PRIVATE_LABEL": { + "surcharge": {} + }, + "UNIONPAY": { + "surcharge": {} + }, + "VISA": { + "surcharge": {} + }, + "OTHER": { + "surcharge": {} + } + } + } + } + }, + "warnings": { + "type": "TAXJAR", + "code": "MISSING_DATA" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"order\": {\n \"countryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1,\n \"type\": \"string\"\n }\n ],\n \"lineItems\": [\n {\n \"itemId\": \"string\",\n \"description\": \"string\",\n \"amount\": 1,\n \"quantity\": 1,\n \"productType\": \"PHYSICAL\"\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"options\": {\n \"\": {\n \"surcharge\": {}\n },\n \"PAYMENT_CARD\": {\n \"networks\": {\n \"AMEX\": {\n \"surcharge\": {}\n },\n \"DANKORT\": {\n \"surcharge\": {}\n },\n \"DINERS_CLUB\": {\n \"surcharge\": {}\n },\n \"DISCOVER\": {\n \"surcharge\": {}\n },\n \"ENROUTE\": {\n \"surcharge\": {}\n },\n \"ELO\": {\n \"surcharge\": {}\n },\n \"HIPER\": {\n \"surcharge\": {}\n },\n \"INTERAC\": {\n \"surcharge\": {}\n },\n \"JCB\": {\n \"surcharge\": {}\n },\n \"MAESTRO\": {\n \"surcharge\": {}\n },\n \"MASTERCARD\": {\n \"surcharge\": {}\n },\n \"MIR\": {\n \"surcharge\": {}\n },\n \"PRIVATE_LABEL\": {\n \"surcharge\": {}\n },\n \"UNIONPAY\": {\n \"surcharge\": {}\n },\n \"VISA\": {\n \"surcharge\": {}\n },\n \"OTHER\": {\n \"surcharge\": {}\n }\n }\n }\n }\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/client-session", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/client-session \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.listPayments": { + "id": "subpackage_paymentsApi.listPayments", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a list of your payments.\n\nResults are paginated, they will only return up to 100 payments maximum.\nTo access the next page of result, set the `cursor` query parameter to the value of `nextCursor` in your current result payload. Use `prevCursor` to go back to the previous page.\n\n**Note:** this endpoint returns a list of summarized payments. Not all payments attributes are present. You can use the query parameters to filter payments.\nYou can separate multiple query parameters with the `&` symbol.\nQuery parameters with types of the form \"Array of strings\" (such as the status parameter) can be specified as a comma-separated list.\n\nFor example, if you wanted to get both `FAILED` and `CANCELLED` payments, for customer `john-123`, you would use:\n\n```bash\ncurl --location --request GET 'https://api.primer.io/payments?status=FAILED,CANCELLED&customer_id=john-123' \\\n--header 'X-Api-Key: '\n```\n\nYou can alternatively specify a list by repeating the parameter multiple times.\n\n**Note:** payments will be available within a minute from being created.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Filter payments by their status." + }, + { + "key": "payment_method_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Filter payments by their payment method type." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment processor." + }, + { + "key": "currency_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Filter payments by their payment currency.\n\nUse the three-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars." + }, + { + "key": "from_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments from this date (inclusive)." + }, + { + "key": "to_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Return only payments up to this date (inclusive)." + }, + { + "key": "order_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Return payments related to this order ID." + }, + { + "key": "min_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount minimum (inclusive)." + }, + { + "key": "max_amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Return payments of this amount max (inclusive)." + }, + { + "key": "customer_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the customer that has made the payment." + }, + { + "key": "merchant_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID of the merchant involved in the payment." + }, + { + "key": "customer_email_address", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Email of the customer that has made the payment." + }, + { + "key": "last_4_digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Last 4 digits of the card used for the payment." + }, + { + "key": "paypal_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Paypal email address associated with the payment." + }, + { + "key": "klarna_email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Klarna email address associated with the payment." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Maximum number of payments to return per page." + }, + { + "key": "cursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If results are paginated, pass the `nextCursor` to access next page." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentListApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "id": "string", + "date": "2024-01-15T09:30:00Z", + "status": "PENDING", + "orderId": "string", + "currencyCode": "string", + "amount": 1 + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": { + "status": "PENDING", + "payment_method_type": "PAYMENT_CARD" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -d status=PENDING \\\n -d payment_method_type=PAYMENT_CARD", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.createPayment": { + "id": "subpackage_paymentsApi.createPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nCreate and authorize a payment for a given customer order. You should provide a payment method token here to avoid PCI implications.\n\nIf only a payment method token is passed, the values passed with the Client Session determine the amount, currency etc.\n\nNote: `amount`, `currencyCode` and `orderId` are required during payment creation. Make sure to pass these fields when creating a client session, or if not yet available, when creating a payment.\n\nAll fields provided on this request will take preference over any field on the `order` associated with the client session. E.g. if you pass `amount` on this request, it will override the `amount` on the `order` associated with the Client Session.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The three-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).\ne.g. use `USD` for US dollars.\n" + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`.\n\nSome currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use `100`. The minimum amount is 0." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment method token used to authorize the payment.\n" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer.\nThis attribute is required if `paymentMethod.vaultOnSuccess` is set to `True`." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n" + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`\n" + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequestPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string", + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "paymentMethod": { + "paymentType": "FIRST_PAYMENT" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "AUTHORIZED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "vaultedPaymentMethodToken": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5", + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\",\n \"order\": {\n \"countryCode\": \"AW\",\n \"fees\": [\n {\n \"amount\": 1,\n \"type\": \"string\"\n }\n ],\n \"lineItems\": [\n {\n \"itemId\": \"string\",\n \"description\": \"string\",\n \"amount\": 1,\n \"quantity\": 1,\n \"productType\": \"PHYSICAL\"\n }\n ],\n \"shipping\": {}\n },\n \"customer\": {\n \"billingAddress\": {\n \"countryCode\": \"AW\"\n },\n \"shippingAddress\": {\n \"countryCode\": \"AW\"\n }\n },\n \"paymentMethod\": {\n \"paymentType\": \"FIRST_PAYMENT\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments", + "responseStatusCode": 422, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": { + "paymentMethodToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paymentMethodToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.capturePayment": { + "id": "subpackage_paymentsApi.capturePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nIf you have successfully authorized a payment, you can now fully capture, or partially capture funds from the authorized payment, depending on whether your selected payment processor supports it. The payment will be updated to `SETTLED` or `SETTLING`, depending on the payment method type.\n\nThe payload sent in this capture request is completely optional. If you don't send a payload with the capture request, the full amount that was authorized will be sent for capture.\n\nBelow are the available payload attributes, which give you more granular control when capturing funds, if you require it.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/capture" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of the payment to capture." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to capture, in minor units. The currency used on authorization is assumed.\n\nIf no amount is specified it defaults to the full amount." + }, + { + "key": "final", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether the capture request is the final capture request.\n\nAfter a final capture, no subsequent captures are allowed." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/capture", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "SETTLED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "vaultedPaymentMethodToken": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5", + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 42, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/capture \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/capture", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/capture \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.cancelPayment": { + "id": "subpackage_paymentsApi.cancelPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nProvided the payment has not reached `SETTLED` status, Primer will send a \"void\" request to the payment processor, thereby cancelling the payment and releasing the hold on customer funds.\n\nUpon success, the payment will transition to `CANCELLED`.\n\nThe payload is optional.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/cancel" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to cancel." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the cancellation. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/cancel", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "CANCELLED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "vaultedPaymentMethodToken": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5", + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "CANCELLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/cancel \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/cancel", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/cancel \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.refundPayment": { + "id": "subpackage_paymentsApi.refundPayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nBy default, this request will refund the full amount.\n\nOptionally, pass in a lesser amount for a partial refund.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/refund" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to refund." + } + ], + "requestHeaders": [ + { + "key": "X-Idempotency-Key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to refund the customer, in minor units. e.g. for $7, use `700`.\n\nDefaults to remaining non-refunded amount." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optionally you can pass a specific order ID for the refund.\n\nBy default this will be set to the original `orderId` given on payment creation." + }, + { + "key": "reason", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "You can optionally specify a reason for the refund. This is for your own records." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/refund", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "SETTLED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "vaultedPaymentMethodToken": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5", + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 42, + "amountRefunded": 42 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "SETTLED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/refund \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/refund", + "responseStatusCode": 422, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": { + "X-Idempotency-Key": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/refund \\\n -H \"X-Idempotency-Key: string\" \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.resumePayment": { + "id": "subpackage_paymentsApi.resumePayment", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nResume a payment's workflow execution from a paused state. This is usually required when a Workflow was paused in order to get further information from the customer, or when waiting for an asynchronous response from a third party connection.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/resume" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to resume." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "resumeToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A token containing any information that is sent back from the checkout to complete a blocked payment flow." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string/resume", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "AUTHORIZED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "vaultedPaymentMethodToken": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5", + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/string/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id/resume", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "resumeToken": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payments/:id/resume \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"resumeToken\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentsApi.getPaymentById": { + "id": "subpackage_paymentsApi.getPaymentById", + "namespace": [ + "subpackage_paymentsApi" + ], + "description": "

\n\nRetrieve a payment by its ID.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payments/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "ID of payment to retrieve." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:PaymentApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payments/string", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "kHdEw9EG", + "date": "2021-02-21T15:36:16.367687", + "status": "AUTHORIZED", + "orderId": "order-abc", + "currencyCode": "EUR", + "amount": 42, + "order": { + "countryCode": "AW", + "fees": [ + { + "amount": 1, + "type": "string" + } + ], + "lineItems": [ + { + "itemId": "string", + "description": "string", + "amount": 1, + "quantity": 1, + "productType": "PHYSICAL" + } + ], + "shipping": {} + }, + "customerId": "customer-123", + "customer": { + "billingAddress": { + "countryCode": "AW" + }, + "shippingAddress": { + "countryCode": "AW" + } + }, + "metadata": { + "productId": 123, + "merchantId": "a13bsd62s" + }, + "paymentMethod": { + "descriptor": "Purchase: Socks", + "paymentMethodToken": "heNwnqaeRiqvY1UcslfQc3wxNjEzOTIxNjc4", + "vaultedPaymentMethodToken": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5", + "analyticsId": "VtkMDAxZW5isH0HsbbNxZ3lo", + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "first6Digits": "411111", + "last4Digits": "1111", + "expirationMonth": "12", + "expirationYear": "2030", + "cardholderName": "John Biggins", + "network": "Visa", + "isNetworkTokenized": false, + "binData": { + "network": "VISA", + "issuerCountryCode": "AW", + "issuerCurrencyCode": "AED", + "regionalRestriction": "UNKNOWN", + "accountNumberType": "UNKNOWN", + "accountFundingType": "UNKNOWN", + "prepaidReloadableIndicator": "NOT_APPLICABLE", + "productUsageType": "UNKNOWN", + "productCode": "VISA", + "productName": "VISA" + } + }, + "threeDSecureAuthentication": { + "responseCode": "NOT_PERFORMED", + "reasonCode": "GATEWAY_UNAVAILABLE" + } + }, + "processor": { + "name": "STRIPE", + "amountCaptured": 0, + "amountRefunded": 0 + }, + "requiredAction": { + "name": "3DS_AUTHENTICATION", + "description": "string" + }, + "statusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + }, + "transactions": [ + { + "processorMerchantId": "acct_stripe_1234", + "transactionType": "SALE", + "processorTransactionId": "54c4eb5b3ef8a", + "processorName": "STRIPE", + "processorStatus": "AUTHORIZED", + "processorStatusReason": { + "type": "APPLICATION_ERROR", + "declineType": "SOFT_DECLINE", + "code": "ERROR" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payments/:id", + "responseStatusCode": 400, + "pathParameters": { + "id": ":id" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.sandbox.primer.io/payments/:id \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post": { + "id": "subpackage_paymentMethodsApi.vault_payment_method_payment_methods__token__vault_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "

\n\nSave a `SINGLE_USE` payment method token so it can be used again later.\n\nIf you try to vault an already vaulted token, you will get the existing vaulted token back.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "token" + }, + { + "type": "literal", + "value": "/vault" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Payment method token to store." + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The ID representing the customer" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_twenty_two_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/vault", + "responseStatusCode": 200, + "pathParameters": { + "token": "string" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:token/vault", + "responseStatusCode": 422, + "pathParameters": { + "token": ":token" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "customerId": "string" + } + }, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:token/vault \\\n -H \"X-API-KEY: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"customerId\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get": { + "id": "subpackage_paymentMethodsApi.get_payment_methods_payment_methods_get", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Retrieve a list of stored payment methods for a customer.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/payment-instruments" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "queryParameters": [ + { + "key": "customer_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Return payment methods for this customer ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenListApiResponse" + } + } + }, + "examples": [ + { + "path": "/payment-instruments", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "customer_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "data": [ + { + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + } + } + ] + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.sandbox.primer.io/payment-instruments \\\n -H \"X-API-KEY: \" \\\n -d customer_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete": { + "id": "subpackage_paymentMethodsApi.delete_payment_method_payment_methods__token__delete", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Delete a saved payment method.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "token" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to delete." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string", + "responseStatusCode": 200, + "pathParameters": { + "token": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/string \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:token", + "responseStatusCode": 400, + "pathParameters": { + "token": ":token" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.sandbox.primer.io/payment-instruments/:token \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post": { + "id": "subpackage_paymentMethodsApi.set_payment_method_default_payment_methods__token__default_post", + "namespace": [ + "subpackage_paymentMethodsApi" + ], + "description": "Update a saved payment method to be the default stored payment method for a customer.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/payment-instruments/" + }, + { + "type": "pathParameter", + "value": "token" + }, + { + "type": "literal", + "value": "/default" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.sandbox.primer.io" + } + ], + "pathParameters": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Saved payment method token to set to default." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:four_hundred_ErrorResponse" + } + } + } + ], + "examples": [ + { + "path": "/payment-instruments/string/default", + "responseStatusCode": 200, + "pathParameters": { + "token": "string" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "paymentMethodType": "PAYMENT_CARD", + "paymentMethodData": { + "last4Digits": "string", + "expirationMonth": "string", + "expirationYear": "string", + "accountFundingType": "CREDIT" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/string/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + }, + { + "path": "/payment-instruments/:token/default", + "responseStatusCode": 400, + "pathParameters": { + "token": ":token" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "errorId": "string", + "description": "string", + "recoverySuggestion": "string", + "diagnosticsId": "string" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.sandbox.primer.io/payment-instruments/:token/default \\\n -H \"X-API-KEY: \"", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:AccountFundingTypeEnum": { + "name": "AccountFundingTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CREDIT" + }, + { + "value": "DEBIT" + }, + { + "value": "PREPAID" + }, + { + "value": "CHARGE" + }, + { + "value": "DEFERRED_DEBIT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ApayaCustomerTokenApiSchema": { + "name": "ApayaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mx", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "mnc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "mcc", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + }, + "type_:BinDataOptionalApiSchema": { + "name": "BinDataOptionalApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + } + } + ] + } + }, + "type_:BinDataApiSchema": { + "name": "BinDataApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "network", + "valueShape": { + "type": "id", + "id": "type_:CardNetworkEnum" + } + }, + { + "key": "issuerCountryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "issuerName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "issuerCurrencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Currency" + } + } + }, + { + "key": "regionalRestriction", + "valueShape": { + "type": "id", + "id": "type_:CardRegionRestrictionEnum" + } + }, + { + "key": "accountNumberType", + "valueShape": { + "type": "id", + "id": "type_:CardAccountNumberTypeEnum" + } + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + { + "key": "prepaidReloadableIndicator", + "valueShape": { + "type": "id", + "id": "type_:PrepaidReloadableEnum" + } + }, + { + "key": "productUsageType", + "valueShape": { + "type": "id", + "id": "type_:CardProductTypeEnum" + } + }, + { + "key": "productCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "productName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:BlockingPaymentActionTypeEnum": { + "name": "BlockingPaymentActionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "3DS_AUTHENTICATION" + }, + { + "value": "USE_PRIMER_SDK" + } + ] + } + }, + "type_:CardAccountNumberTypeEnum": { + "name": "CardAccountNumberTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PRIMARY_ACCOUNT_NUMBER" + }, + { + "value": "NETWORK_TOKEN" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardNetworkEnum": { + "name": "CardNetworkEnum", + "description": "The list of available card networks.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AMEX" + }, + { + "value": "DANKORT" + }, + { + "value": "DINERS_CLUB" + }, + { + "value": "DISCOVER" + }, + { + "value": "ENROUTE" + }, + { + "value": "ELO" + }, + { + "value": "HIPER" + }, + { + "value": "INTERAC" + }, + { + "value": "JCB" + }, + { + "value": "MAESTRO" + }, + { + "value": "MASTERCARD" + }, + { + "value": "MIR" + }, + { + "value": "PRIVATE_LABEL" + }, + { + "value": "UNIONPAY" + }, + { + "value": "VISA" + }, + { + "value": "OTHER" + } + ] + } + }, + "type_:CardProductTypeEnum": { + "name": "CardProductTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "CONSUMER" + }, + { + "value": "BUSINESS" + }, + { + "value": "GOVERNMENT" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:CardRegionRestrictionEnum": { + "name": "CardRegionRestrictionEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "DOMESTIC_USE_ONLY" + }, + { + "value": "NONE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:ClientSessionUpdateApiRequest": { + "name": "ClientSessionUpdateApiRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the order." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The three-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). e.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you would like to charge the customer, in minor units. e.g. for $7, use `700`." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nProvide the entire object to update it. Anything provided previously will be overwritten." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutCustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order.\n\nEach of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment method. Provide the entire object to update it. Anything provided previously will be overwritten." + } + ] + } + }, + "type_:OrderDetailsApiSchema": { + "name": "OrderDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + }, + "description": "The country in which the order is created" + }, + { + "key": "fees", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderFeesApiSchema" + } + } + }, + "description": "The details of fees charged." + }, + { + "key": "lineItems", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:OrderLineItemsApiSchema" + } + } + }, + "description": "The details of the line items of the order." + }, + { + "key": "shipping", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderShippingApiSchema" + } + }, + "description": "The details of shipping charged." + } + ] + } + }, + "type_:OrderFeesApiSchema": { + "name": "OrderFeesApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The fee amount charged to the customer, in minor units. e.g. for $7, use `700`." + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The type of fee." + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the fee, e.g. \"Currency Conversion Fee\"." + } + ] + } + }, + "type_:OrderLineItemsApiSchema": { + "name": "OrderLineItemsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "itemId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A unique identifier for the line item." + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A description of the item." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The amount charged to the customer, in minor units. The minimum amount is 0." + }, + { + "key": "discountAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Any discount applicable to this item, in minor units." + }, + { + "key": "quantity", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The number of the particular line item that is being ordered." + }, + { + "key": "taxAmount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The tax charged on this item (if known), in minor units." + }, + { + "key": "taxCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The tax code associated with this item, in minor units. This is required for Primer-initiated tax calculations." + }, + { + "key": "productType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ProductTypeEnum" + } + }, + "description": "An identifier for the product type." + } + ] + } + }, + "type_:OrderShippingApiSchema": { + "name": "OrderShippingApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The shipping amount charged to the customer, in minor units. e.g. for $7, use `700`." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchemaOptions": { + "name": "CheckoutPaymentMethodOptionsApiSchemaOptions", + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionApiSchema" + } + } + }, + { + "key": "PAYMENT_CARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodCardOptionApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionsApiSchema": { + "name": "CheckoutPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "options", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchemaOptions" + } + }, + "description": "Additional options for the payment methods represented as dictionary\nwith key of [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) and value of corresponding options." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionApiSchema": { + "name": "CheckoutPaymentMethodOptionApiSchema", + "description": "Options for the payment method of type `PAYMENT_METHOD_TYPE`.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + }, + "description": "Surcharge information" + } + ] + } + }, + "type_:CheckoutPaymentMethodCardOptionApiSchema": { + "name": "CheckoutPaymentMethodCardOptionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "networks", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema" + } + }, + "description": "Dictionary of available card networks as a key with value of Payment Method Card Network Option." + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "AMEX", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DANKORT", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DINERS_CLUB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "DISCOVER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ENROUTE", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "ELO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "HIPER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "INTERAC", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "JCB", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MAESTRO", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MASTERCARD", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "MIR", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "PRIVATE_LABEL", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "UNIONPAY", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "VISA", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + }, + { + "key": "OTHER", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionCardNetworkSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "surcharge", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionSurchargeApiSchema" + } + }, + "description": "Surcharge information" + } + ] + } + }, + "type_:CheckoutPaymentMethodOptionSurchargeApiSchema": { + "name": "CheckoutPaymentMethodOptionSurchargeApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated." + } + ] + } + }, + "type_:PaymentRequestPaymentMethodOptionsApiSchema": { + "name": "PaymentRequestPaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "vaultOnSuccess", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the payment method should be vaulted on a successful payment or not." + }, + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RecurringTransactionTypeEnum" + } + }, + "description": "Payment types, primarily to be used for recurring payments.\nNote: If you successfully vault a `SINGLE_USE` token on payment creation, then there's no need to set a value for this field and it will be flagged as `FIRST_PAYMENT`. Otherwise, see the table below for all possible values.\n\n| paymentType | Use case |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `FIRST_PAYMENT` | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |\n| `ECOMMERCE` | a customer-initiated payment using stored payment details where the cardholder is present. |\n| `SUBSCRIPTION` | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |\n| `UNSCHEDULED` | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |" + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData": { + "name": "PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Order Token Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalOrderTokenApiSchema" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Payment Session Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaPaymentSessionApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Ideal Pay Nl Token Api Schema", + "shape": { + "type": "id", + "id": "type_:IdealPayNlTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:PaymentResponsePaymentMethodOptionsApiSchema": { + "name": "PaymentResponsePaymentMethodOptionsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "descriptor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the payment, as it would typically appear on a bank statement." + }, + { + "key": "paymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment method token used to authorize the transaction." + }, + { + "key": "vaultedPaymentMethodToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If the payment method token was vaulted, this is the new token. Use this token for recurring payments." + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type" + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchemaPaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "threeDSecureAuthentication", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchema" + } + } + } + ] + } + }, + "type_:CheckoutCustomerDetailsApiSchema": { + "name": "CheckoutCustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address." + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer billing address." + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:CustomerDetailsApiSchema": { + "name": "CustomerDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "emailAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Customer email address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "mobileNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's mobile number" + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's first name" + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's last name" + }, + { + "key": "billingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer billing address.\n\nNote: It is recommended to include this field if a 3DS check will be performed" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema" + } + }, + "description": "Customer shipping address" + }, + { + "key": "taxId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's tax id number for tax exemptions" + }, + { + "key": "nationalDocumentId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The customer's national identification number" + } + ] + } + }, + "type_:ClientSessionApiResponse": { + "name": "ClientSessionApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Client token used to initialize the SDK on all platforms." + }, + { + "key": "clientTokenExpirationDate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Expiration date & time of the client token (UTC with no timezoneinfo)." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The three-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). e.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you are going to charge the customer, in minor units. This amount is calculated from the line items, shipping and other amounts provided in the `order`.\nIf a top-level amount is provided, it would override any calculated amount." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CheckoutPaymentMethodOptionsApiSchema" + } + }, + "description": "Enable certain options associated with the payment methods." + }, + { + "key": "warnings", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ClientSessionWarningsApiResponse" + } + }, + "description": "Warning messages to indicate missing information that are required for payment methods, checkout modules and other features; or when third-party services are unavailable." + } + ] + } + }, + "type_:ClientSessionWarningsApiResponse": { + "name": "ClientSessionWarningsApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the connection involved" + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique code describing the particular issue" + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "More information as to the reason for the warning" + } + ] + } + }, + "type_:CountryCodeEnum": { + "name": "CountryCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "AW" + }, + { + "value": "AF" + }, + { + "value": "AO" + }, + { + "value": "AI" + }, + { + "value": "AX" + }, + { + "value": "AL" + }, + { + "value": "AD" + }, + { + "value": "AE" + }, + { + "value": "AR" + }, + { + "value": "AM" + }, + { + "value": "AS" + }, + { + "value": "AQ" + }, + { + "value": "TF" + }, + { + "value": "AG" + }, + { + "value": "AU" + }, + { + "value": "AT" + }, + { + "value": "AZ" + }, + { + "value": "BI" + }, + { + "value": "BE" + }, + { + "value": "BJ" + }, + { + "value": "BQ" + }, + { + "value": "BF" + }, + { + "value": "BD" + }, + { + "value": "BG" + }, + { + "value": "BH" + }, + { + "value": "BS" + }, + { + "value": "BA" + }, + { + "value": "BL" + }, + { + "value": "BY" + }, + { + "value": "BZ" + }, + { + "value": "BM" + }, + { + "value": "BO" + }, + { + "value": "BR" + }, + { + "value": "BB" + }, + { + "value": "BN" + }, + { + "value": "BT" + }, + { + "value": "BV" + }, + { + "value": "BW" + }, + { + "value": "CF" + }, + { + "value": "CA" + }, + { + "value": "CC" + }, + { + "value": "CH" + }, + { + "value": "CL" + }, + { + "value": "CN" + }, + { + "value": "CI" + }, + { + "value": "CM" + }, + { + "value": "CD" + }, + { + "value": "CG" + }, + { + "value": "CK" + }, + { + "value": "CO" + }, + { + "value": "KM" + }, + { + "value": "CV" + }, + { + "value": "CR" + }, + { + "value": "CU" + }, + { + "value": "CW" + }, + { + "value": "CX" + }, + { + "value": "KY" + }, + { + "value": "CY" + }, + { + "value": "CZ" + }, + { + "value": "DE" + }, + { + "value": "DJ" + }, + { + "value": "DM" + }, + { + "value": "DK" + }, + { + "value": "DO" + }, + { + "value": "DZ" + }, + { + "value": "EC" + }, + { + "value": "EG" + }, + { + "value": "ER" + }, + { + "value": "EH" + }, + { + "value": "ES" + }, + { + "value": "EE" + }, + { + "value": "ET" + }, + { + "value": "FI" + }, + { + "value": "FJ" + }, + { + "value": "FK" + }, + { + "value": "FR" + }, + { + "value": "FO" + }, + { + "value": "FM" + }, + { + "value": "GA" + }, + { + "value": "GB" + }, + { + "value": "GE" + }, + { + "value": "GG" + }, + { + "value": "GH" + }, + { + "value": "GI" + }, + { + "value": "GN" + }, + { + "value": "GP" + }, + { + "value": "GM" + }, + { + "value": "GW" + }, + { + "value": "GQ" + }, + { + "value": "GR" + }, + { + "value": "GD" + }, + { + "value": "GL" + }, + { + "value": "GT" + }, + { + "value": "GF" + }, + { + "value": "GU" + }, + { + "value": "GY" + }, + { + "value": "HK" + }, + { + "value": "HM" + }, + { + "value": "HN" + }, + { + "value": "HR" + }, + { + "value": "HT" + }, + { + "value": "HU" + }, + { + "value": "ID" + }, + { + "value": "IM" + }, + { + "value": "IN" + }, + { + "value": "IO" + }, + { + "value": "IE" + }, + { + "value": "IR" + }, + { + "value": "IQ" + }, + { + "value": "IS" + }, + { + "value": "IL" + }, + { + "value": "IT" + }, + { + "value": "JM" + }, + { + "value": "JE" + }, + { + "value": "JO" + }, + { + "value": "JP" + }, + { + "value": "KZ" + }, + { + "value": "KE" + }, + { + "value": "KG" + }, + { + "value": "KH" + }, + { + "value": "KI" + }, + { + "value": "KN" + }, + { + "value": "KR" + }, + { + "value": "KW" + }, + { + "value": "LA" + }, + { + "value": "LB" + }, + { + "value": "LR" + }, + { + "value": "LY" + }, + { + "value": "LC" + }, + { + "value": "LI" + }, + { + "value": "LK" + }, + { + "value": "LS" + }, + { + "value": "LT" + }, + { + "value": "LU" + }, + { + "value": "LV" + }, + { + "value": "MO" + }, + { + "value": "MF" + }, + { + "value": "MA" + }, + { + "value": "MC" + }, + { + "value": "MD" + }, + { + "value": "MG" + }, + { + "value": "MV" + }, + { + "value": "MX" + }, + { + "value": "MH" + }, + { + "value": "MK" + }, + { + "value": "ML" + }, + { + "value": "MT" + }, + { + "value": "MM" + }, + { + "value": "ME" + }, + { + "value": "MN" + }, + { + "value": "MP" + }, + { + "value": "MZ" + }, + { + "value": "MR" + }, + { + "value": "MS" + }, + { + "value": "MQ" + }, + { + "value": "MU" + }, + { + "value": "MW" + }, + { + "value": "MY" + }, + { + "value": "YT" + }, + { + "value": "NA" + }, + { + "value": "NC" + }, + { + "value": "NE" + }, + { + "value": "NF" + }, + { + "value": "NG" + }, + { + "value": "NI" + }, + { + "value": "NU" + }, + { + "value": "NL" + }, + { + "value": "NO" + }, + { + "value": "NP" + }, + { + "value": "NR" + }, + { + "value": "NZ" + }, + { + "value": "OM" + }, + { + "value": "PK" + }, + { + "value": "PA" + }, + { + "value": "PN" + }, + { + "value": "PE" + }, + { + "value": "PH" + }, + { + "value": "PW" + }, + { + "value": "PG" + }, + { + "value": "PL" + }, + { + "value": "PR" + }, + { + "value": "KP" + }, + { + "value": "PT" + }, + { + "value": "PY" + }, + { + "value": "PS" + }, + { + "value": "PF" + }, + { + "value": "QA" + }, + { + "value": "RE" + }, + { + "value": "RO" + }, + { + "value": "RU" + }, + { + "value": "RW" + }, + { + "value": "SA" + }, + { + "value": "SD" + }, + { + "value": "SN" + }, + { + "value": "SG" + }, + { + "value": "GS" + }, + { + "value": "SH" + }, + { + "value": "SJ" + }, + { + "value": "SB" + }, + { + "value": "SL" + }, + { + "value": "SV" + }, + { + "value": "SM" + }, + { + "value": "SO" + }, + { + "value": "PM" + }, + { + "value": "RS" + }, + { + "value": "SS" + }, + { + "value": "ST" + }, + { + "value": "SR" + }, + { + "value": "SK" + }, + { + "value": "SI" + }, + { + "value": "SE" + }, + { + "value": "SZ" + }, + { + "value": "SX" + }, + { + "value": "SC" + }, + { + "value": "SY" + }, + { + "value": "TC" + }, + { + "value": "TD" + }, + { + "value": "TG" + }, + { + "value": "TH" + }, + { + "value": "TJ" + }, + { + "value": "TK" + }, + { + "value": "TM" + }, + { + "value": "TL" + }, + { + "value": "TO" + }, + { + "value": "TT" + }, + { + "value": "TN" + }, + { + "value": "TR" + }, + { + "value": "TV" + }, + { + "value": "TW" + }, + { + "value": "TZ" + }, + { + "value": "UG" + }, + { + "value": "UA" + }, + { + "value": "UM" + }, + { + "value": "UY" + }, + { + "value": "US" + }, + { + "value": "UZ" + }, + { + "value": "VA" + }, + { + "value": "VC" + }, + { + "value": "VE" + }, + { + "value": "VG" + }, + { + "value": "VI" + }, + { + "value": "VN" + }, + { + "value": "VU" + }, + { + "value": "WF" + }, + { + "value": "WS" + }, + { + "value": "YE" + }, + { + "value": "ZA" + }, + { + "value": "ZM" + }, + { + "value": "ZW" + } + ] + } + }, + "type_:Currency": { + "name": "Currency", + "description": "Enumerates all supported currencies", + "shape": { + "type": "enum", + "values": [ + { + "value": "AED" + }, + { + "value": "AFN" + }, + { + "value": "ALL" + }, + { + "value": "AMD" + }, + { + "value": "ANG" + }, + { + "value": "AOA" + }, + { + "value": "ARS" + }, + { + "value": "AUD" + }, + { + "value": "AWG" + }, + { + "value": "AZN" + }, + { + "value": "BAM" + }, + { + "value": "BBD" + }, + { + "value": "BDT" + }, + { + "value": "BGN" + }, + { + "value": "BHD" + }, + { + "value": "BIF" + }, + { + "value": "BMD" + }, + { + "value": "BND" + }, + { + "value": "BOB" + }, + { + "value": "BOV" + }, + { + "value": "BRL" + }, + { + "value": "BSD" + }, + { + "value": "BTN" + }, + { + "value": "BWP" + }, + { + "value": "BYR" + }, + { + "value": "BYN" + }, + { + "value": "BZD" + }, + { + "value": "CAD" + }, + { + "value": "CDF" + }, + { + "value": "CHE" + }, + { + "value": "CHF" + }, + { + "value": "CHW" + }, + { + "value": "CLF" + }, + { + "value": "CLP" + }, + { + "value": "CNY" + }, + { + "value": "COP" + }, + { + "value": "COU" + }, + { + "value": "CRC" + }, + { + "value": "CUC" + }, + { + "value": "CUP" + }, + { + "value": "CVE" + }, + { + "value": "CZK" + }, + { + "value": "DJF" + }, + { + "value": "DKK" + }, + { + "value": "DOP" + }, + { + "value": "DZD" + }, + { + "value": "EGP" + }, + { + "value": "ERN" + }, + { + "value": "ETB" + }, + { + "value": "EUR" + }, + { + "value": "FJD" + }, + { + "value": "FKP" + }, + { + "value": "GBP" + }, + { + "value": "GEL" + }, + { + "value": "GHS" + }, + { + "value": "GIP" + }, + { + "value": "GMD" + }, + { + "value": "GNF" + }, + { + "value": "GTQ" + }, + { + "value": "GYD" + }, + { + "value": "HKD" + }, + { + "value": "HNL" + }, + { + "value": "HRK" + }, + { + "value": "HTG" + }, + { + "value": "HUF" + }, + { + "value": "IDR" + }, + { + "value": "ILS" + }, + { + "value": "INR" + }, + { + "value": "IQD" + }, + { + "value": "IRR" + }, + { + "value": "ISK" + }, + { + "value": "JMD" + }, + { + "value": "JOD" + }, + { + "value": "JPY" + }, + { + "value": "KES" + }, + { + "value": "KGS" + }, + { + "value": "KHR" + }, + { + "value": "KMF" + }, + { + "value": "KPW" + }, + { + "value": "KRW" + }, + { + "value": "KWD" + }, + { + "value": "KYD" + }, + { + "value": "KZT" + }, + { + "value": "LAK" + }, + { + "value": "LBP" + }, + { + "value": "LKR" + }, + { + "value": "LRD" + }, + { + "value": "LSL" + }, + { + "value": "LTL" + }, + { + "value": "LVL" + }, + { + "value": "LYD" + }, + { + "value": "MAD" + }, + { + "value": "MDL" + }, + { + "value": "MGA" + }, + { + "value": "MKD" + }, + { + "value": "MMK" + }, + { + "value": "MNT" + }, + { + "value": "MOP" + }, + { + "value": "MRO" + }, + { + "value": "MUR" + }, + { + "value": "MVR" + }, + { + "value": "MWK" + }, + { + "value": "MXN" + }, + { + "value": "MXV" + }, + { + "value": "MYR" + }, + { + "value": "MZN" + }, + { + "value": "NAD" + }, + { + "value": "NGN" + }, + { + "value": "NIO" + }, + { + "value": "NOK" + }, + { + "value": "NPR" + }, + { + "value": "NZD" + }, + { + "value": "OMR" + }, + { + "value": "PAB" + }, + { + "value": "PEN" + }, + { + "value": "PGK" + }, + { + "value": "PHP" + }, + { + "value": "PKR" + }, + { + "value": "PLN" + }, + { + "value": "PYG" + }, + { + "value": "QAR" + }, + { + "value": "RON" + }, + { + "value": "RSD" + }, + { + "value": "RUB" + }, + { + "value": "RWF" + }, + { + "value": "SAR" + }, + { + "value": "SBD" + }, + { + "value": "SCR" + }, + { + "value": "SDG" + }, + { + "value": "SEK" + }, + { + "value": "SGD" + }, + { + "value": "SHP" + }, + { + "value": "SLL" + }, + { + "value": "SOS" + }, + { + "value": "SRD" + }, + { + "value": "SSP" + }, + { + "value": "STD" + }, + { + "value": "SVC" + }, + { + "value": "SYP" + }, + { + "value": "SZL" + }, + { + "value": "THB" + }, + { + "value": "TJS" + }, + { + "value": "TMT" + }, + { + "value": "TND" + }, + { + "value": "TOP" + }, + { + "value": "TRY" + }, + { + "value": "TTD" + }, + { + "value": "TWD" + }, + { + "value": "TZS" + }, + { + "value": "UAH" + }, + { + "value": "UGX" + }, + { + "value": "USD" + }, + { + "value": "USN" + }, + { + "value": "USS" + }, + { + "value": "UYI" + }, + { + "value": "UYU" + }, + { + "value": "UZS" + }, + { + "value": "VEF" + }, + { + "value": "VND" + }, + { + "value": "VUV" + }, + { + "value": "WST" + }, + { + "value": "XAF" + }, + { + "value": "XAG" + }, + { + "value": "XAU" + }, + { + "value": "XBA" + }, + { + "value": "XBB" + }, + { + "value": "XBC" + }, + { + "value": "XBD" + }, + { + "value": "XCD" + }, + { + "value": "XDR" + }, + { + "value": "XFU" + }, + { + "value": "XOF" + }, + { + "value": "XPD" + }, + { + "value": "XPF" + }, + { + "value": "XPT" + }, + { + "value": "XSU" + }, + { + "value": "XTS" + }, + { + "value": "XUA" + }, + { + "value": "YER" + }, + { + "value": "ZAR" + }, + { + "value": "ZMW" + }, + { + "value": "ZWL" + } + ] + } + }, + "type_:PaymentResponseProcessorApiSchema": { + "name": "PaymentResponseProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + }, + { + "key": "amountCaptured", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no capture was performed, this value will be set to `0`.\n\nIf one or more partial captures were performed, this value will be a sum\nof all partial capture amounts." + }, + { + "key": "amountRefunded", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "If no refund was performed, this value will be set to `0`.\n\nIf one or more partial refunds were performed, this value will be a sum\nof all partial refund amounts." + } + ] + } + }, + "type_:GoCardlessMandateApiSchema": { + "name": "GoCardlessMandateApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "gocardlessMandateId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique identifier of a GoCardless mandate agreement" + } + ] + } + }, + "type_:IdealPayNlTokenApiSchema": { + "name": "IdealPayNlTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paymentMethodConfigId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:KlarnaAddressApiSchema": { + "name": "KlarnaAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "phoneNumber", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine3", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:KlarnaCustomerTokenApiSchema": { + "name": "KlarnaCustomerTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaCustomerToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaPaymentSessionApiSchema": { + "name": "KlarnaPaymentSessionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "klarnaAuthorizationToken", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "sessionData", + "valueShape": { + "type": "id", + "id": "type_:KlarnaSessionDetailsApiSchema" + } + } + ] + } + }, + "type_:KlarnaSessionDetailsApiSchema": { + "name": "KlarnaSessionDetailsApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "recurringDescription", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "billingAddress", + "valueShape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaAddressApiSchema" + } + } + }, + { + "key": "purchaseCountry", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "purchaseCurrency", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "locale", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "orderLines", + "valueShape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + { + "key": "tokenDetails", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:KlarnaTokenDetails" + } + } + } + ] + } + }, + "type_:KlarnaTokenDetails": { + "name": "KlarnaTokenDetails", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "brand", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "masked_number", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiry_date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalBillingAgreementApiSchema": { + "name": "PayPalBillingAgreementApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalBillingAgreementId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "shippingAddress", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddressApiSchema" + } + }, + "description": "The PayPal customer's shipping address" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalExternalPayerInfoApiSchema": { + "name": "PayPalExternalPayerInfoApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "externalPayerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PayPalOrderTokenApiSchema": { + "name": "PayPalOrderTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paypalOrderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "externalPayerInfo", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PayPalExternalPayerInfoApiSchema" + } + }, + "description": "Information about the PayPal customer" + }, + { + "key": "paypalStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentApiResponse": { + "name": "PaymentApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your reference for the payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The three-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). e.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The amount you charged the customer, in minor units." + }, + { + "key": "order", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:OrderDetailsApiSchema" + } + }, + "description": "More information associated with the order." + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for your customer." + }, + { + "key": "customer", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CustomerDetailsApiSchema" + } + }, + "description": "More information associated with the customer." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle." + }, + { + "key": "paymentMethod", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponsePaymentMethodOptionsApiSchema" + } + }, + "description": "The payment method options provided in the request, as well as the token used to process the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentResponseProcessorApiSchema" + } + }, + "description": "More information associated with the payment processor, including the processor name." + }, + { + "key": "requiredAction", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentRequiredActionApiSchema" + } + }, + "description": "Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance." + }, + { + "key": "statusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "Check this field for more information regarding the payment's status. This is especially useful when the status is `DECLINED` or `FAILED`." + }, + { + "key": "transactions", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:TransactionOverviewApiSchema" + } + } + }, + "description": "A list summarizing the transactions that occurred while processing the payment.\n\nNote: a refund is a separate transaction and so will appear in this `transactions` list if a refund was performed." + } + ] + } + }, + "type_:PaymentCardTokenApiSchema": { + "name": "PaymentCardTokenApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "first6Digits", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "isNetworkTokenized", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "binData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:BinDataApiSchema" + } + } + } + ] + } + }, + "type_:StatusReasonApiSchema": { + "name": "StatusReasonApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatusTypeEnum" + }, + "description": "Type of the status." + }, + { + "key": "declineType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:DeclineTypeEnum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED` this will be returned.\n\nDeclines of type `SOFT_DECLINE` may be retried,\nwhereas declines of type `HARD_DECLINE` should not be retried." + }, + { + "key": "code", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionDeclineReasonV2Enum" + } + }, + "description": "If the error is of type `ISSUER_DECLINED`, this will be returned." + }, + { + "key": "message", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "In case of an error on the processor's part, we will return the message returned by the processor. This is usually a human readable error." + } + ] + } + }, + "type_:PaymentMethodTypeEnum": { + "name": "PaymentMethodTypeEnum", + "description": "Payment method type, where `OFF_SESSION_PAYMENT` is used for APM (Alternative Payment Method) payments and `PAYMENT_CARD` for traditional debit or credit cards. Please note that this list is different from one indicated on [available payment methods](https://primer.io/docs/payment-methods/available-payment-methods) page and values of this field will be changed in the future versions of the API.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PAYMENT_CARD" + }, + { + "value": "PAYPAL_ORDER" + }, + { + "value": "PAYPAL_BILLING_AGREEMENT" + }, + { + "value": "GOCARDLESS_MANDATE" + }, + { + "value": "KLARNA_AUTHORIZATION_TOKEN" + }, + { + "value": "KLARNA_CUSTOMER_TOKEN" + }, + { + "value": "PAY_NL_IDEAL" + }, + { + "value": "APAYA" + }, + { + "value": "OFF_SESSION_PAYMENT" + }, + { + "value": "CARD_OFF_SESSION_PAYMENT" + }, + { + "value": "APPLE_PAY" + }, + { + "value": "APPLE_PAY_ENCRYPTED_TOKEN" + }, + { + "value": "GOOGLE_PAY" + } + ] + } + }, + "type_:PaymentListApiResponse": { + "name": "PaymentListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:PaymentSummaryApiSchema" + } + } + } + }, + { + "key": "nextCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "prevCursor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:PaymentRequiredActionApiSchema": { + "name": "PaymentRequiredActionApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "id", + "id": "type_:BlockingPaymentActionTypeEnum" + }, + "description": "Action name" + }, + { + "key": "description", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Human description of the required action to perform." + }, + { + "key": "clientToken", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The client token to be returned to the SDK if a required action is returned." + } + ] + } + }, + "type_:PaymentSummaryApiSchema": { + "name": "PaymentSummaryApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The unique payment ID.\n\nYou can use this ID to retrieve the payment details, or perform downstream\noperations." + }, + { + "key": "date", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "The date and time at which the payment was created in UTC format." + }, + { + "key": "status", + "valueShape": { + "type": "id", + "id": "type_:PaymentStatus" + }, + "description": "See the payment [status table](../docs#payment-status) for more information." + }, + { + "key": "orderId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Your reference for the payment." + }, + { + "key": "processor", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "currencyCode", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The three-letter currency code in [ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). e.g. use `USD` for US dollars." + }, + { + "key": "amount", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "The payment amount, in minor units. e.g. $7 would show as `700`." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Additional data to be used throughout the payment lifecycle.\n\nA dictionary of key-value pairs where the values can only be strings or\nintegers.\n\ne.g. `{\"productId\": 1001, \"merchantId\": \"a13bsd62s\"}`" + } + ] + } + }, + "type_:PaymentSummaryProcessorApiSchema": { + "name": "PaymentSummaryProcessorApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "The payment processor used for this payment." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The merchant ID registered at the payment processor used for this payment." + } + ] + } + }, + "type_:PrepaidReloadableEnum": { + "name": "PrepaidReloadableEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RELOADABLE" + }, + { + "value": "NON_RELOADABLE" + }, + { + "value": "NOT_APPLICABLE" + }, + { + "value": "UNKNOWN" + } + ] + } + }, + "type_:RecurringTransactionTypeEnum": { + "name": "RecurringTransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "FIRST_PAYMENT" + }, + { + "value": "ECOMMERCE" + }, + { + "value": "SUBSCRIPTION" + }, + { + "value": "UNSCHEDULED" + } + ] + } + }, + "type_:ProductTypeEnum": { + "name": "ProductTypeEnum", + "description": "An enumeration", + "shape": { + "type": "enum", + "values": [ + { + "value": "PHYSICAL" + }, + { + "value": "DIGITAL" + } + ] + } + }, + "type_:ThreeDSecureAuthResponseCodeEnum": { + "name": "ThreeDSecureAuthResponseCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "NOT_PERFORMED" + }, + { + "value": "SKIPPED" + }, + { + "value": "AUTH_SUCCESS" + }, + { + "value": "AUTH_FAILED" + }, + { + "value": "CHALLENGE" + }, + { + "value": "METHOD" + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchemaReasonCode": { + "name": "ThreeDSecureAuthenticationApiSchemaReasonCode", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Three D Secure Skipped Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureSkippedReasonCodeEnum" + } + }, + { + "displayName": "Three D Secure Failed Reason Code Enum", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureFailedReasonCodeEnum" + } + } + ] + } + }, + "type_:ThreeDSecureAuthenticationApiSchema": { + "name": "ThreeDSecureAuthenticationApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "responseCode", + "valueShape": { + "type": "id", + "id": "type_:ThreeDSecureAuthResponseCodeEnum" + } + }, + { + "key": "reasonCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ThreeDSecureAuthenticationApiSchemaReasonCode" + } + } + }, + { + "key": "reasonText", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "protocolVersion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "challengeIssued", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:ThreeDSecureFailedReasonCodeEnum": { + "name": "ThreeDSecureFailedReasonCodeEnum", + "description": "This enum is derived from the `transStatusReason` on page 218 of the\n[EMV Co 3DS protocol specification](https://www.emvco.com/terms-of-use/?u=/wp-content/uploads/documents/EMVCo_3DS_Spec_v220_122018.pdf)\n\n| Code | Description |\n| ---- | --------------------------------------- |\n| 01 | Card authentication failed |\n| 02 | Unknown Device |\n| 03 | Unsupported Device |\n| 04 | Exceeds authentication frequency limit |\n| 05 | Expired card |\n| 06 | Invalid card number |\n| 07 | Invalid transaction |\n| 08 | No Card record |\n| 09 | Security failure |\n| 10 | Stolen card |\n| 11 | Suspected fraud |\n| 12 | Transaction not permitted to cardholder |\n| 13 | Cardholder not enrolled in service |\n| 14 | Transaction timed out at the ACS |\n| 15 | Low confidence |\n| 16 | Medium confidence |", + "shape": { + "type": "enum", + "values": [ + { + "value": "UNKNOWN" + }, + { + "value": "REJECTED_BY_ISSUER" + }, + { + "value": "CARD_AUTHENTICATION_FAILED" + }, + { + "value": "UNKNOWN_DEVICE" + }, + { + "value": "UNSUPPORTED_DEVICE" + }, + { + "value": "EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "INVALID_TRANSACTION" + }, + { + "value": "NO_CARD_RECORD" + }, + { + "value": "SECURITY_FAILURE" + }, + { + "value": "STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER" + }, + { + "value": "CARDHOLDER_NOT_ENROLLED_IN_SERVICE" + }, + { + "value": "TRANSACTION_TIMED_OUT_AT_THE_ACS" + }, + { + "value": "LOW_CONFIDENCE" + }, + { + "value": "MEDIUM_CONFIDENCE" + }, + { + "value": "HIGH_CONFIDENCE" + }, + { + "value": "VERY_HIGH_CONFIDENCE" + }, + { + "value": "EXCEEDS_ACS_MAXIMUM_CHALLENGES" + }, + { + "value": "NON_PAYMENT_NOT_SUPPORTED" + }, + { + "value": "THREE_RI_NOT_SUPPORTED" + }, + { + "value": "ACS_TECHNICAL_ISSUE" + }, + { + "value": "DECOUPLED_REQUIRED_BY_ACS" + }, + { + "value": "DECOUPLED_MAX_EXPIRY_EXCEEDED" + }, + { + "value": "DECOUPLED_AUTHENTICATION_INSUFFICIENT_TIME" + }, + { + "value": "AUTHENTICATION_ATTEMPTED_BUT_NOT_PERFORMED_BY_CARDHOLDER" + }, + { + "value": "ACS_TIMED_OUT" + }, + { + "value": "INVALID_ACS_RESPONSE" + }, + { + "value": "ACS_SYSTEM_ERROR_RESPONSE" + }, + { + "value": "ERROR_GENERATING_CAVV" + }, + { + "value": "PROTOCOL_VERSION_NOT_SUPPORTED" + }, + { + "value": "TRANSACTION_EXCLUDED_FROM_ATTEMPTS_PROCESSING" + }, + { + "value": "REQUESTED_PROGRAM_NOT_SUPPORTED" + } + ] + } + }, + "type_:ThreeDSecureSkippedReasonCodeEnum": { + "name": "ThreeDSecureSkippedReasonCodeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "GATEWAY_UNAVAILABLE" + }, + { + "value": "DISABLED_BY_MERCHANT" + }, + { + "value": "NOT_SUPPORTED_BY_ISSUER" + }, + { + "value": "FAILED_TO_NEGOTIATE" + }, + { + "value": "UNKNOWN_ACS_RESPONSE" + }, + { + "value": "3DS_SERVER_ERROR" + }, + { + "value": "ACQUIRER_NOT_CONFIGURED" + }, + { + "value": "ACQUIRER_NOT_PARTICIPATING" + } + ] + } + }, + "type_:TokenTypeEnum": { + "name": "TokenTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "MULTI_USE" + }, + { + "value": "SINGLE_USE" + } + ] + } + }, + "type_:DeclineTypeEnum": { + "name": "DeclineTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SOFT_DECLINE" + }, + { + "value": "HARD_DECLINE" + } + ] + } + }, + "type_:TransactionDeclineReasonV2Enum": { + "name": "TransactionDeclineReasonV2Enum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "ERROR" + }, + { + "value": "INVALID_CARD_NUMBER" + }, + { + "value": "EXPIRED_CARD" + }, + { + "value": "LOST_OR_STOLEN_CARD" + }, + { + "value": "SUSPECTED_FRAUD" + }, + { + "value": "UNKNOWN" + }, + { + "value": "DECLINED" + }, + { + "value": "REFER_TO_CARD_ISSUER" + }, + { + "value": "DO_NOT_HONOR" + }, + { + "value": "INSUFFICIENT_FUNDS" + }, + { + "value": "WITHDRAWAL_LIMIT_EXCEEDED" + }, + { + "value": "ISSUER_TEMPORARILY_UNAVAILABLE" + }, + { + "value": "AUTHENTICATION_REQUIRED" + } + ] + } + }, + "type_:TransactionOverviewApiSchema": { + "name": "TransactionOverviewApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "transactionType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:TransactionTypeEnum" + } + } + }, + { + "key": "processorTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Processor's unique identifier for the transaction" + }, + { + "key": "processorName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An identifier of a processor." + }, + { + "key": "processorMerchantId", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Processor's main account identifier.\n\n- Adyen: Account code\n- Braintree: Merchant ID\n- Stripe: Account ID\"" + }, + { + "key": "processorStatus", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentStatus" + } + }, + "description": "Transaction status, please refer to the [Transaction Status Codes](#section/API-Usage-Guide/Payment-Status) table for more information" + }, + { + "key": "processorStatusReason", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StatusReasonApiSchema" + } + }, + "description": "If the transaction has a declined or failed status.\n\nOnly if the status is `DECLINED` or `FAILED`, otherwise `null`." + } + ] + } + }, + "type_:PaymentStatus": { + "name": "PaymentStatus", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "PENDING" + }, + { + "value": "FAILED" + }, + { + "value": "AUTHORIZED" + }, + { + "value": "SETTLING" + }, + { + "value": "PARTIALLY_SETTLED" + }, + { + "value": "SETTLED" + }, + { + "value": "DECLINED" + }, + { + "value": "CANCELLED" + } + ] + } + }, + "type_:PaymentStatusTypeEnum": { + "name": "PaymentStatusTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "APPLICATION_ERROR" + }, + { + "value": "GATEWAY_REJECTED" + }, + { + "value": "ISSUER_DECLINED" + } + ] + } + }, + "type_:TransactionTypeEnum": { + "name": "TransactionTypeEnum", + "description": "An enumeration.", + "shape": { + "type": "enum", + "values": [ + { + "value": "SALE" + }, + { + "value": "REFUND" + } + ] + } + }, + "type_:CoreApiApiCommonsSchemasAddessAddressApiSchema": { + "name": "CoreApiApiCommonsSchemasAddessAddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "city", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "countryCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:CountryCodeEnum" + } + } + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:AddressApiSchema": { + "name": "AddressApiSchema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "firstName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "lastName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "addressLine1", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Street name, Company name or PO Box" + }, + { + "key": "addressLine2", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Apartment, Unit or Building number" + }, + { + "key": "city", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Name of the city, district, town or village" + }, + { + "key": "state", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "State, County or Province" + }, + { + "key": "countryCode", + "valueShape": { + "type": "id", + "id": "type_:CountryCodeEnum" + }, + "description": "Two letter ISO country code" + }, + { + "key": "postalCode", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Postal or ZIP code" + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData": { + "name": "MerchantPaymentMethodTokenApiResponsePaymentMethodData", + "description": "Payment method data", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Payment Card Token Api Schema Payment Methods Api", + "shape": { + "type": "id", + "id": "type_:PaymentCardTokenApiSchemaPaymentMethodsApi" + } + }, + { + "displayName": "Pay Pal Billing Agreement Api Schema", + "shape": { + "type": "id", + "id": "type_:PayPalBillingAgreementApiSchema" + } + }, + { + "displayName": "Go Cardless Mandate Api Schema", + "shape": { + "type": "id", + "id": "type_:GoCardlessMandateApiSchema" + } + }, + { + "displayName": "Klarna Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:KlarnaCustomerTokenApiSchema" + } + }, + { + "displayName": "Apaya Customer Token Api Schema", + "shape": { + "type": "id", + "id": "type_:ApayaCustomerTokenApiSchema" + } + } + ] + } + }, + "type_:MerchantPaymentMethodTokenApiResponse": { + "name": "MerchantPaymentMethodTokenApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "createdAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Creation date & time of the object (UTC)" + }, + { + "key": "deletedAt", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date & time when this object was revoked. (UTC)" + }, + { + "key": "deleted", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this object has been revoked." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The vaulted payment method token." + }, + { + "key": "tokenType", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "- `MULTI_USE` a vaulted token that can be re-used with subsequent payments" + }, + { + "key": "analyticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Unique analytics identifier corresponding to a payment method" + }, + { + "key": "paymentMethodType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:PaymentMethodTypeEnum" + } + }, + "description": "Payment method type associated with a token." + }, + { + "key": "paymentMethodData", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponsePaymentMethodData" + } + }, + "description": "Payment method data" + }, + { + "key": "customerId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID representing the customer" + }, + { + "key": "default", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not this payment method is the default" + } + ] + } + }, + "type_:MerchantPaymentMethodTokenListApiResponse": { + "name": "MerchantPaymentMethodTokenListApiResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:MerchantPaymentMethodTokenApiResponse" + } + } + } + } + ] + } + }, + "type_:PaymentCardTokenApiSchemaPaymentMethodsApi": { + "name": "PaymentCardTokenApiSchemaPaymentMethodsApi", + "description": "Used exclusively by the Payment Methods API", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "last4Digits", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationMonth", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "expirationYear", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "cardholderName", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "network", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "networkTransactionId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An ID for the transaction assigned by the card network. Used to correlate recurring payments." + }, + { + "key": "accountFundingType", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AccountFundingTypeEnum" + } + }, + "description": "The type of card, e.g. Debit, Credit" + } + ] + } + }, + "type_:ErrorObject": { + "name": "ErrorObject", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "errorId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An error ID" + }, + { + "key": "description", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A human description of the error" + }, + { + "key": "recoverySuggestion", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A human readable recovery suggestion of the error" + }, + { + "key": "diagnosticsId", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An ID that you can quote when contacting the Primer support team via our [JIRA Service Desk](https://primerapi.atlassian.net/servicedesk/customer/portal/11)." + } + ] + } + }, + "type_:four_hundred_ErrorResponse": { + "name": "four_hundred_ErrorResponse", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ErrorObject" + } + } + }, + "type_:four_hundred_twenty_two_ErrorResponse": { + "name": "four_hundred_twenty_two_ErrorResponse", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:ErrorObject" + } + } + } + }, + "subpackages": { + "subpackage_clientSessionApi": { + "id": "subpackage_clientSessionApi", + "name": "Client Session API" + }, + "subpackage_paymentsApi": { + "id": "subpackage_paymentsApi", + "name": "Payments API" + }, + "subpackage_paymentMethodsApi": { + "id": "subpackage_paymentMethodsApi", + "name": "Payment Methods API" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "X-API-KEY", + "nameOverride": "apiKey" + } + } + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/node.json b/packages/fdr-sdk/src/__test__/output/primer/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/node.json rename to packages/fdr-sdk/src/__test__/output/primer/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/primer/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/primer/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/primer/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/primer/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/pageIds.json b/packages/fdr-sdk/src/__test__/output/primer/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/pageIds.json rename to packages/fdr-sdk/src/__test__/output/primer/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/sitemap.json b/packages/fdr-sdk/src/__test__/output/primer/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/sitemap.json rename to packages/fdr-sdk/src/__test__/output/primer/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/primer/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/primer/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/primer/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/primer/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/slugs.json b/packages/fdr-sdk/src/__test__/output/primer/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/slugs.json rename to packages/fdr-sdk/src/__test__/output/primer/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/primer/versionNodes.json b/packages/fdr-sdk/src/__test__/output/primer/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/primer/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/primer/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-15c16fe3-9b9c-4a04-ae4f-f9749d504bc7.json b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-15c16fe3-9b9c-4a04-ae4f-f9749d504bc7.json new file mode 100644 index 0000000000..9100a18817 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-15c16fe3-9b9c-4a04-ae4f-f9749d504bc7.json @@ -0,0 +1,574 @@ +[ + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/UPLOADCARE_PUB_KEY/property/UPLOADCARE_PUB_KEY", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/UPLOADCARE_STORE/property/UPLOADCARE_STORE", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/{filename}/file/{filename}", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/metadata[{key}]/property/metadata[{key}]", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/signature/property/signature", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/expire/property/expire", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/2/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/3/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/4/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/UPLOADCARE_PUB_KEY", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/UPLOADCARE_STORE", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/filename", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/size", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/part_size", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/content_type", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/metadata[{key}]", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/signature", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object/property/expire", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/2/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/3/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadPart/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/request/object/property/UPLOADCARE_PUB_KEY", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/request/object/property/uuid", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/2/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/3/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/pub_key", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/source_url", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/store", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/filename", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/check_URL_duplicates", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/save_URL_duplicates", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/metadata[{key}]", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/signature", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object/property/expire", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/2/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/3/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/query/token", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/query/pub_key", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/query/file_id", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/2/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/3/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/request/object/property/pub_key", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/request/object/property/files[]", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/request/object/property/signature", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/request/object/property/expire", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/2/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/query/pub_key", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/query/group_id", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0/snippet/javascript/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0/snippet/php/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0/snippet/python/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0/snippet/ruby/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0/snippet/swift/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0/snippet/kotlin/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/1/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/2/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/3/snippet/curl/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:BaseUploadResponse/shape/object/property/filename", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:MultipartFileUploadStartResponse/shape/object/property/uuid", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:MultipartFileUploadStartResponse/shape/object/property/parts", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestCheckUrlDuplicates/shape/enum/value/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestCheckUrlDuplicates/shape/enum/value/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestSaveUrlDuplicates/shape/enum/value/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestSaveUrlDuplicates/shape/enum/value/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadResponse/shape/undiscriminatedUnion/variant/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadResponse/shape/undiscriminatedUnion/variant/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadStatusResponse/shape/undiscriminatedUnion/variant/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadStatusResponse/shape/undiscriminatedUnion/variant/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadStatusResponse/shape/undiscriminatedUnion/variant/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadStatusResponse/shape/undiscriminatedUnion/variant/3", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadStatusResponse/shape/undiscriminatedUnion/variant/4", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:StoreType/shape/enum/value/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:StoreType/shape/enum/value/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:StoreType/shape/enum/value/auto", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/uuid", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/file_id", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/size", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/total", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/done", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/original_filename", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/filename", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/mime_type", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/image_info", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/video_info", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/content_info", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/metadata", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/is_image", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/is_stored", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/is_ready", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object/property/s3_bucket", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoWaitingStatus/shape/object/property/status", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoProgressStatus/shape/object/property/status", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoProgressStatus/shape/object/property/total", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoProgressStatus/shape/object/property/done", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoSuccessStatus/shape/object/property/status", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoErrorStatus/shape/object/property/status", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoErrorStatus/shape/object/property/error", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoErrorStatus/shape/object/property/error_code", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoUnknownStatus/shape/object/property/status", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoFromUrl/shape/object/property/type", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FromUrlUploadResponseSchema/shape/object/property/type", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FromUrlUploadResponseSchema/shape/object/property/token", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object/property/id", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object/property/datetime_created", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object/property/datetime_stored", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object/property/files_count", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object/property/cdn_url", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object/property/url", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object/property/files", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGB", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGBA", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGBa", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGBX", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/L", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/LA", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/La", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/P", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/PA", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/CMYK", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/YCbCr", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/HSV", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape/enum/value/LAB", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoGeoLocation/shape/object/property/latitude", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoGeoLocation/shape/object/property/longitude", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/color_mode", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/orientation", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/format", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/sequence", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/height", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/width", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/geo_location", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/datetime_original", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object/property/dpi", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoAudio/shape/object/property/bitrate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoAudio/shape/object/property/codec", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoAudio/shape/object/property/sample_rate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoAudio/shape/object/property/channels", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo/shape/object/property/height", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo/shape/object/property/width", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo/shape/object/property/frame_rate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo/shape/object/property/bitrate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo/shape/object/property/codec", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo/shape/object/property/duration", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo/shape/object/property/format", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo/shape/object/property/bitrate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo/shape/object/property/audio", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo/shape/object/property/video", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/RGB", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/RGBA", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/RGBa", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/RGBX", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/L", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/LA", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/La", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/P", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/PA", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/CMYK", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/YCbCr", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/HSV", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape/enum/value/LAB", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoGeoLocation/shape/object/property/latitude", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoGeoLocation/shape/object/property/longitude", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/color_mode", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/orientation", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/format", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/sequence", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/height", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/width", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/geo_location", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/datetime_original", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object/property/dpi", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoAudioItem/shape/object/property/bitrate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoAudioItem/shape/object/property/codec", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoAudioItem/shape/object/property/sample_rate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoAudioItem/shape/object/property/channels", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem/shape/object/property/height", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem/shape/object/property/width", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem/shape/object/property/frame_rate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem/shape/object/property/bitrate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem/shape/object/property/codec", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo/shape/object/property/duration", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo/shape/object/property/format", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo/shape/object/property/bitrate", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo/shape/object/property/audio", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo/shape/object/property/video", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfoMime/shape/object/property/mime", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfoMime/shape/object/property/type", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfoMime/shape/object/property/subtype", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfo/shape/object/property/mime", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfo/shape/object/property/image", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfo/shape/object/property/video", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/1/403/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/2/413/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/3/429/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/error/1/403/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/error/2/429/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadPart/request", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/error/1/403/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/error/2/404/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/error/1/403/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/error/2/429/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/error/1/403/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/error/2/404/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/error/1/403/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/response", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/error/0/400/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/error/1/403/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/error/2/404/error/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureType/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ExpireType/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ProjectPublicKeyType/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MetadataValue/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AutoStoreDisabledError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UploadcarePublicKeyRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:PublicKeyRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UploadcarePublicKeyInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:PublicKeyInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ProjectPublicKeyRemovedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AccountBlockedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AccountUnpaidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UploadFailedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AccountLimitsExceededError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureExpirationError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:RequestFiledsNumberLimitExceededError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:PostRequestParserFailedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:NullCharactersForbiddenError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyDuplicatedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyEmptyError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyForbiddenError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyLengthTooBigError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataValueEmptyError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataValueForbiddenError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataValueLengthTooBigError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeysNumberTooBigError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FilesRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileSizeLimitExceededError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileTypeForbiddenError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileInfectedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:RequestParamRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartSizeInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileSizeLimitExceededError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileSizeTooSmallError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartPartSizeInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartPartSizeTooSmallError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartPartSizeTooBigError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileIdRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileAlreadyUploadedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartUploadSizeTooLargeError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartUploadSizeTooSmallError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileCompletionFailedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UuidInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SourceUrlRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlParsingFailedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlSchemeRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlSchemeInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlHostRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlBlacklistedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:HostnameNotFoundError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlHostMalformedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlHostPrivateIpForbiddenError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:TokenRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileIdRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileIdInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileNotFoundError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupFilesInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupFileUrlParsingFailedError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupFilesNotFoundError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupIdRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupNotFoundError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureExpirationRequiredError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureExpirationInvalidError/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:Metadata/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/UPLOADCARE_PUB_KEY", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/UPLOADCARE_STORE", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/{filename}", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/metadata[{key}]", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/signature", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata/field/expire", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/request/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/request/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:BaseUploadResponse/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:MultipartFileUploadStartResponse/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoWaitingStatus/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoProgressStatus/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoSuccessStatus/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoErrorStatus/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoUnknownStatus/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoFromUrl/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FromUrlUploadResponseSchema/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoGeoLocation/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoAudio/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoGeoLocation/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoAudioItem/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfoMime/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfo/shape/object", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestCheckUrlDuplicates/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestSaveUrlDuplicates/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadResponse/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadStatusResponse/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureType", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ExpireType", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:StoreType/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ProjectPublicKeyType", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MetadataValue", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AutoStoreDisabledError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UploadcarePublicKeyRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:PublicKeyRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UploadcarePublicKeyInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:PublicKeyInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ProjectPublicKeyRemovedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AccountBlockedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AccountUnpaidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UploadFailedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:AccountLimitsExceededError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureExpirationError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:RequestFiledsNumberLimitExceededError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:PostRequestParserFailedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:NullCharactersForbiddenError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyDuplicatedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyEmptyError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyForbiddenError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeyLengthTooBigError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataValueEmptyError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataValueForbiddenError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataValueLengthTooBigError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileMetadataKeysNumberTooBigError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FilesRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileSizeLimitExceededError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileTypeForbiddenError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileInfectedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:RequestParamRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartSizeInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileSizeLimitExceededError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileSizeTooSmallError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartPartSizeInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartPartSizeTooSmallError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartPartSizeTooBigError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileIdRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileAlreadyUploadedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartUploadSizeTooLargeError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartUploadSizeTooSmallError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:MultipartFileCompletionFailedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UuidInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SourceUrlRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlParsingFailedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlSchemeRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlSchemeInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlHostRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlBlacklistedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:HostnameNotFoundError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlHostMalformedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:UrlHostPrivateIpForbiddenError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:TokenRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileIdRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileIdInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileNotFoundError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupFilesInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupFileUrlParsingFailedError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupFilesNotFoundError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupIdRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupNotFoundError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureExpirationRequiredError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SignatureExpirationInvalidError", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:Metadata", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/1/403", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/2/413", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/error/3/429", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/3", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/example/4", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/error/1/403", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/error/2/429", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/example/3", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadPart/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/error/1/403", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/error/2/404", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/example/3", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/error/1/403", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/error/2/429", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/example/3", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/error/1/403", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/error/2/404", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo/example/3", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/error/1/403", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/example/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/error/0/400", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/error/1/403", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/error/2/404", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/0", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/1", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/2", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo/example/3", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request/formdata", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart/request", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete/request", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload/request", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup/request", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:BaseUploadResponse/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:MultipartFileUploadStartResponse/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestCheckUrlDuplicates", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadRequestSaveUrlDuplicates", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadResponse", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:FromUrlUploadStatusResponse", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:StoreType", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoWaitingStatus/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoProgressStatus/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoSuccessStatus/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoErrorStatus/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoUnknownStatus/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoFromUrl/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FromUrlUploadResponseSchema/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoColorMode", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoGeoLocation/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoAudio/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoColorMode", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoGeoLocation/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoAudioItem/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfoMime/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfo/shape", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:BaseUploadResponse", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_upload:MultipartFileUploadStartResponse", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoWaitingStatus", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoProgressStatus", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoSuccessStatus", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoErrorStatus", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoUnknownStatus", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FileUploadInfoFromUrl", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:FromUrlUploadResponseSchema", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:GroupInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfoGeoLocation", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ImageInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoAudio", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfoVideo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:LegacyVideoInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfoGeoLocation", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:SchemasImageInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoAudioItem", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfoVideoItem", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:VideoInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfoMime", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/type-definition/type_:ContentInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload/request", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadStart", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadPart", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.multipartFileUploadComplete", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUpload", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fromURLUploadStatus", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.fileUploadInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.createFilesGroup", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_groups.filesGroupInfo", + "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7/endpoint/subpackage_upload.baseUpload" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-6e1b77b7-26ce-4bba-9544-a24a9b3519dc.json b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-6e1b77b7-26ce-4bba-9544-a24a9b3519dc.json new file mode 100644 index 0000000000..747352e206 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-6e1b77b7-26ce-4bba-9544-a24a9b3519dc.json @@ -0,0 +1,60 @@ +[ + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/path/uuid", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/example/0/snippet/curl/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/example/1/snippet/curl/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/path/uuid", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/example/0/snippet/curl/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/example/1/snippet/curl/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileNames.fileWithName/path/uuid", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileNames.fileWithName/path/filename", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileNames.fileWithName/example/0/snippet/curl/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/RGB", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/RGBA", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/RGBa", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/RGBX", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/L", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/LA", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/La", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/P", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/PA", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/CMYK", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/YCbCr", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/HSV", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape/enum/value/LAB", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileGeoLocation/shape/object/property/latitude", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileGeoLocation/shape/object/property/longitude", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/id", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/dpi", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/width", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/format", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/height", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/sequence", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/color_mode", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/orientation", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/geo_location", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/datetime_original", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object/property/hash", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/response", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/error/0/404/error/shape", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/response", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/error/0/404/error/shape", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileNames.fileWithName/response", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileGeoLocation/shape/object", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape/object", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode/shape", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/error/0/404", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/example/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson/example/1", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/error/0/404", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/example/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp/example/1", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileNames.fileWithName/example/0", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileColorMode", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileGeoLocation/shape", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File/shape", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:FileGeoLocation", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/type-definition/type_:File", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJson", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileInformation.fileInfoJsonp", + "6e1b77b7-26ce-4bba-9544-a24a9b3519dc/endpoint/subpackage_fileNames.fileWithName" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-fb019a78-a773-4315-9c7b-6dcb585d6b30.json b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-fb019a78-a773-4315-9c7b-6dcb585d6b30.json new file mode 100644 index 0000000000..c2d1df6ca5 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitionKeys-fb019a78-a773-4315-9c7b-6dcb585d6b30.json @@ -0,0 +1,1415 @@ +[ + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/query/removed", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/query/stored", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/query/limit", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/query/ordering", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/query/from", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/query/include", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/query/include", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/request/object/property/source", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/request/object/property/store", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/request/object/property/metadata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/request/object/property/source", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/request/object/property/target", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/request/object/property/make_public", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/request/object/property/pattern", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/request/object/property/target", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/query/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/request/object/property/target", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/query/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/request/object/property/target", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/request/object/property/params", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/query/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/request/object/property/target", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/request/object/property/params", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/query/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/path/key", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/path/key", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/path/key", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/query/limit", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/query/from", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/query/ordering", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/path/id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/path/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/5/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/request/object/property/paths", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/request/object/property/store", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/request/object/property/save_in_group", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/path/token", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/5/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/request/object/property/paths", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/request/object/property/store", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/path/token", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0/snippet/javascript/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0/snippet/php/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0/snippet/python/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0/snippet/ruby/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0/snippet/swift/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0/snippet/kotlin/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/1/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/2/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/3/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/4/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/5/snippet/curl/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListRequestOrdering/shape/enum/value/datetime_uploaded", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListRequestOrdering/shape/enum/value/-datetime_uploaded", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponseTotals/shape/object/property/removed", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponseTotals/shape/object/property/stored", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponseTotals/shape/object/property/unstored", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape/object/property/next", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape/object/property/previous", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape/object/property/total", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape/object/property/totals", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape/object/property/per_page", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape/object/property/results", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesStoringResponse/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesStoringResponse/shape/object/property/problems", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesStoringResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesDeleteResponse/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesDeleteResponse/shape/object/property/problems", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesDeleteResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateLocalCopyRequestStore/shape/enum/value/true", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateLocalCopyRequestStore/shape/enum/value/false", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern/shape/enum/value/${default}", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern/shape/enum/value/${auto_filename}", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern/shape/enum/value/${effects}", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern/shape/enum/value/${filename}", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern/shape/enum/value/${uuid}", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern/shape/enum/value/${ext}", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecuteResponse/shape/object/property/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponseStatus/shape/enum/value/in_progress", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponseStatus/shape/enum/value/error", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponseStatus/shape/enum/value/done", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponseStatus/shape/enum/value/unknown", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponse/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecuteResponse/shape/object/property/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus/shape/enum/value/in_progress", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus/shape/enum/value/error", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus/shape/enum/value/done", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus/shape/enum/value/unknown", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponse/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteRequestParams/shape/object/property/purge_infected", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteResponse/shape/object/property/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponseStatus/shape/enum/value/in_progress", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponseStatus/shape/enum/value/error", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponseStatus/shape/enum/value/done", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponseStatus/shape/enum/value/unknown", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponse/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsTypeLevel/shape/enum/value/none", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsTypeLevel/shape/enum/value/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsTypeLevel/shape/enum/value/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsTypeLevel/shape/enum/value/latest", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsType/shape/enum/value/auto", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsType/shape/enum/value/person", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsType/shape/enum/value/product", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsType/shape/enum/value/car", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsChannels/shape/enum/value/rgba", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsChannels/shape/enum/value/alpha", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/crop", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/crop_margin", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/scale", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/add_shadow", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/type_level", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/semitransparency", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/channels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/roi", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object/property/position", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteResponse/shape/object/property/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponseResult/shape/object/property/file_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListRequestOrdering/shape/enum/value/datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListRequestOrdering/shape/enum/value/-datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse/shape/object/property/next", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse/shape/object/property/previous", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse/shape/object/property/total", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse/shape/object/property/per_page", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse/shape/object/property/results", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormatConversionFormatsItem/shape/object/property/name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormat/shape/object/property/name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormat/shape/object/property/conversion_formats", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseConvertedGroups/shape/object/property/{conversion_format}", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponse/shape/object/property/error", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponse/shape/object/property/format", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponse/shape/object/property/converted_groups", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersStore/shape/enum/value/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersStore/shape/enum/value/false", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersStore/shape/enum/value/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersStore/shape/enum/value/true", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersSaveInGroup/shape/enum/value/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersSaveInGroup/shape/enum/value/false", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersSaveInGroup/shape/enum/value/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersSaveInGroup/shape/enum/value/true", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponseResultItem/shape/object/property/original_source", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponseResultItem/shape/object/property/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponseResultItem/shape/object/property/token", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponse/shape/object/property/problems", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseStatus/shape/enum/value/pending", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseStatus/shape/enum/value/processing", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseStatus/shape/enum/value/finished", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseStatus/shape/enum/value/failed", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseStatus/shape/enum/value/cancelled", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseResult/shape/object/property/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponse/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponse/shape/object/property/error", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoJobSubmitParametersStore/shape/enum/value/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoJobSubmitParametersStore/shape/enum/value/false", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoJobSubmitParametersStore/shape/enum/value/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoJobSubmitParametersStore/shape/enum/value/true", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponseResultItem/shape/object/property/original_source", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponseResultItem/shape/object/property/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponseResultItem/shape/object/property/token", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponseResultItem/shape/object/property/thumbnails_group_uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponse/shape/object/property/problems", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseStatus/shape/enum/value/pending", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseStatus/shape/enum/value/processing", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseStatus/shape/enum/value/finished", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseStatus/shape/enum/value/failed", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseStatus/shape/enum/value/cancelled", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseResult/shape/object/property/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseResult/shape/object/property/thumbnails_group_uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponse/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponse/shape/object/property/error", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatusStatus/shape/enum/value/in_progress", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatusStatus/shape/enum/value/error", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatusStatus/shape/enum/value/done", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatusStatus/shape/enum/value/unknown", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatus/shape/object/property/status", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFilePayload/shape/object/property/initiator", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFilePayload/shape/object/property/hook", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFilePayload/shape/object/property/data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFilePayload/shape/object/property/file", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayloadPreviousValues/shape/object/property/appdata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayloadPreviousValues/shape/object/property/metadata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload/shape/object/property/initiator", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload/shape/object/property/hook", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload/shape/object/property/data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload/shape/object/property/file", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload/shape/object/property/previous_values", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/datetime_removed", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/datetime_stored", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/datetime_uploaded", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/is_image", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/is_ready", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/mime_type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/original_file_url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/original_filename", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/size", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/variations", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/content_info", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object/property/metadata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/datetime_removed", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/datetime_stored", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/datetime_uploaded", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/is_image", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/is_ready", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/mime_type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/original_file_url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/original_filename", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/size", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/appdata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/variations", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/content_info", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object/property/metadata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfoMime/shape/object/property/mime", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfoMime/shape/object/property/type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfoMime/shape/object/property/subtype", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfo/shape/object/property/mime", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfo/shape/object/property/image", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfo/shape/object/property/video", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGB", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGBA", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGBa", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/RGBX", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/L", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/LA", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/La", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/P", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/PA", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/CMYK", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/YCbCr", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/HSV", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape/enum/value/LAB", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoGeoLocation/shape/object/property/latitude", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoGeoLocation/shape/object/property/longitude", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/color_mode", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/orientation", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/format", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/sequence", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/height", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/width", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/geo_location", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/datetime_original", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object/property/dpi", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoAudioItem/shape/object/property/bitrate", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoAudioItem/shape/object/property/codec", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoAudioItem/shape/object/property/sample_rate", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoAudioItem/shape/object/property/channels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem/shape/object/property/height", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem/shape/object/property/width", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem/shape/object/property/frame_rate", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem/shape/object/property/bitrate", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem/shape/object/property/codec", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo/shape/object/property/duration", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo/shape/object/property/format", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo/shape/object/property/bitrate", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo/shape/object/property/audio", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo/shape/object/property/video", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CopiedFileUrl/shape/object/property/type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CopiedFileUrl/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group/shape/object/property/id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group/shape/object/property/datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group/shape/object/property/files_count", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group/shape/object/property/cdn_url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group/shape/object/property/url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:GroupWithFiles/shape/object/property/files", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ProjectCollaboratorsItem/shape/object/property/email", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ProjectCollaboratorsItem/shape/object/property/name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Project/shape/object/property/collaborators", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Project/shape/object/property/name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Project/shape/object/property/pub_key", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Project/shape/object/property/autostore_enabled", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookEvent/shape/enum/value/file.uploaded", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookEvent/shape/enum/value/file.infected", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookEvent/shape/enum/value/file.stored", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookEvent/shape/enum/value/file.deleted", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookEvent/shape/enum/value/file.info_updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfListResponse/shape/enum/value/", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfListResponse/shape/enum/value/0.5", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfListResponse/shape/enum/value/0.6", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfListResponse/shape/enum/value/0.7", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/project", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/event", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/target_url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/is_active", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object/property/signing_secret", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/project", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/event", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/target_url", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/is_active", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object/property/signing_secret", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorType/shape/enum/value/api", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorType/shape/enum/value/system", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorType/shape/enum/value/addon", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName/shape/enum/value/aws_rekognition_detect_labels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName/shape/enum/value/aws_rekognition_detect_moderation_labels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName/shape/enum/value/uc_clamav_virus_scan", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName/shape/enum/value/remove_bg", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName/shape/enum/value/zamzar_convert_document", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName/shape/enum/value/zencoder_convert_video", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetail/shape/object/property/request_id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetail/shape/object/property/addon_name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetail/shape/object/property/source_file_uuid", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiator/shape/object/property/type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiator/shape/object/property/detail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/id", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/project", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/project_pub_key", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/created_at", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/updated_at", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/event", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/target", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/is_active", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseDocsConversionError/shape/object/property/detail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseVideoConversionError/shape/object/property/detail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseWebhooksError/shape/object/property/detail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:JsonObjectParseError/shape/object/property/detail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:LocalCopyResponse/shape/object/property/type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:LocalCopyResponse/shape/object/property/result", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationData/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationData/shape/object/property/datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationData/shape/object/property/datetime_updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationData/shape/object/property/data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10Data/shape/object/property/foreground_type", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10/shape/object/property/data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10/shape/object/property/datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10/shape/object/property/datetime_updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox/shape/object/property/Height", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox/shape/object/property/Left", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox/shape/object/property/Top", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox/shape/object/property/Width", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem/shape/object/property/BoundingBox", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem/shape/object/property/Confidence", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem/shape/object/property/Name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem/shape/object/property/Confidence", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem/shape/object/property/Instances", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem/shape/object/property/Name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem/shape/object/property/Parents", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627Data/shape/object/property/LabelModelVersion", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627Data/shape/object/property/Labels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627/shape/object/property/data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627/shape/object/property/datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627/shape/object/property/datetime_updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem/shape/object/property/Confidence", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem/shape/object/property/Name", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem/shape/object/property/ParentName", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627Data/shape/object/property/ModerationModelVersion", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627Data/shape/object/property/ModerationLabels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627/shape/object/property/data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627/shape/object/property/datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627/shape/object/property/datetime_updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanVersion/shape/enum/value/0.104.2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanVersion/shape/enum/value/0.104.3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanVersion/shape/enum/value/0.105.0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanVersion/shape/enum/value/0.105.1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanData/shape/object/property/infected", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanData/shape/object/property/infected_with", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScan/shape/object/property/version", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScan/shape/object/property/data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScan/shape/object/property/datetime_created", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScan/shape/object/property/datetime_updated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationDataObject/shape/object/property/aws_rekognition_detect_labels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationDataObject/shape/object/property/aws_rekognition_detect_moderation_labels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationDataObject/shape/object/property/remove_bg", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationDataObject/shape/object/property/uc_clamav_virus_scan", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:SimpleAuthHttpForbidden/shape/object/property/detail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookTargetUrlError/shape/object/property/detail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/2/409/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/2/409/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/2/409/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/2/409/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/error/0/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/error/1/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/error/2/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/4/503/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/4/503/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/response", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/0/400/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/1/401/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/2/404/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/3/429/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/4/503/error/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Metadata/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:MetadataItemValue/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookId/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookProject/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookProjectPubkey/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookCreated/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookUpdated/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookTarget/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookIsActive/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookSigningSecret/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersion/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfRequest/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/request/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponseTotals/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesStoringResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesDeleteResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecuteResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecuteResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteRequestParams/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponseResult/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormatConversionFormatsItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormat/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseConvertedGroups/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponseResultItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseResult/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponseResultItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseResult/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatus/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFilePayload/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayloadPreviousValues/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfoMime/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfo/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoGeoLocation/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoAudioItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CopiedFileUrl/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:GroupWithFiles/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ProjectCollaboratorsItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Project/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetail/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiator/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseDocsConversionError/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseVideoConversionError/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseWebhooksError/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:JsonObjectParseError/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:LocalCopyResponse/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationData/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10Data/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627Data/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627Data/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanData/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScan/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationDataObject/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:SimpleAuthHttpForbidden/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookTargetUrlError/shape/object", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListRequestOrdering/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateLocalCopyRequestStore/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponseStatus/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponseStatus/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsTypeLevel/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsType/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsChannels/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListRequestOrdering/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersStore/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersSaveInGroup/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseStatus/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoJobSubmitParametersStore/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseStatus/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatusStatus/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Metadata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:MetadataItemValue", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookId", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookProject", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookProjectPubkey", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookCreated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookUpdated", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookTarget", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookEvent/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookIsActive", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookSigningSecret", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersion", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfRequest", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfListResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorType/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanVersion/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/2/409", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/2/409", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/2/409", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/2/409", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/error/0/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/error/1/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/error/2/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/error/4/503", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo/example/5", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/error/4/503", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus/example/5", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/0/400", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/1/401", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/2/404", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/3/429", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/error/4/503", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/0", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/1", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/2", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/3", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/4", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus/example/5", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert/request", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListRequestOrdering", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponseTotals/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesStoringResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesDeleteResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateLocalCopyRequestStore", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:CreateRemoteCopyRequestPattern", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecuteResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponseStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecuteResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteRequestParams/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponseStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsTypeLevel", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsType", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParamsChannels", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponseResult/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListRequestOrdering", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormatConversionFormatsItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormat/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseConvertedGroups/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersStore", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentJobSubmitParametersSaveInGroup", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponseResultItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseResult/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoJobSubmitParametersStore", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponseResultItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseResult/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatusStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatus/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFilePayload/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayloadPreviousValues/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfoMime/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfo/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoColorMode", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoGeoLocation/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoAudioItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CopiedFileUrl/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:GroupWithFiles/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ProjectCollaboratorsItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Project/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookEvent", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookVersionOfListResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorType", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetailAddonName", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetail/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiator/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseDocsConversionError/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseVideoConversionError/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseWebhooksError/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:JsonObjectParseError/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:LocalCopyResponse/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationData/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10Data/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627Data/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627Data/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanVersion", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanData/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScan/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationDataObject/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:SimpleAuthHttpForbidden/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookTargetUrlError/shape", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponseTotals", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesListResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesStoringResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_file:FilesDeleteResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecuteResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionExecutionStatusResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecuteResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteRequestParams", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecuteResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:UcClamavVirusScanExecutionStatusResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteRequestParams", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecuteResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponseResult", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_addOns:RemoveBgExecutionStatusResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_group:GroupsListResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormatConversionFormatsItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseFormat", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponseConvertedGroups", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertInfoResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponseResultItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponseResult", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:DocumentConvertStatusResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponseResultItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponseResult", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_conversion:VideoConvertStatusResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AddonExecutionStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFilePayload", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayloadPreviousValues", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookFileInfoUpdatedPayload", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:FileCopy", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:File", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfoMime", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ContentInfo", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfoGeoLocation", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ImageInfo", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoAudioItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfoVideoItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:VideoInfo", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CopiedFileUrl", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Group", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:GroupWithFiles", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ProjectCollaboratorsItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Project", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:Webhook", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookOfListResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiatorDetail", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookInitiator", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookPublicInfo", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseDocsConversionError", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseVideoConversionError", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:CantUseWebhooksError", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:JsonObjectParseError", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:LocalCopyResponse", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationData", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10Data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:RemoveBgV10", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627Data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectLabelsV20160627", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627Data", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:AwsRekognitionDetectModerationLabelsV20160627", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScanData", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:UcClamavVirusScan", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:ApplicationDataObject", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:SimpleAuthHttpForbidden", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/type-definition/type_:WebhookTargetUrlError", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/__package__.File metadata", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesList", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.storeFile", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.deleteFileStorage", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.info", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesStoring", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.filesDelete", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createLocalCopy", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_file.createRemoteCopy", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecute", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionExecutionStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecute", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecute", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.ucClamavVirusScanExecutionStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecute", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_addOns.removeBgExecutionStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.key", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.updateFileMetadataKey", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_fileMetadata.deleteFileMetadataKey", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.groupsList", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.info", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_group.deleteGroup", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_project.info", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.webhooksList", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.create", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.updateWebhook", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_webhook.unsubscribe", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertInfo", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvert", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.documentConvertStatus", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvert", + "fb019a78-a773-4315-9c7b-6dcb585d6b30/endpoint/subpackage_conversion.videoConvertStatus" +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitions.json new file mode 100644 index 0000000000..6cf7d700fc --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/uploadcare/apiDefinitions.json @@ -0,0 +1,18525 @@ +[ + { + "id": "6e1b77b7-26ce-4bba-9544-a24a9b3519dc", + "endpoints": { + "subpackage_fileInformation.fileInfoJson": { + "id": "subpackage_fileInformation.fileInfoJson", + "namespace": [ + "subpackage_fileInformation" + ], + "description": "Returns file-related information, such as image dimensions or geo\ntagging data in the JSON format.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/-/json" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://ucarecdn.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique file identifier" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:File" + } + } + }, + "errors": [ + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/d7fe74ac-65b8-4ade-875f-ccd92759a70f/-/json", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "d7fe74ac-65b8-4ade-875f-ccd92759a70f" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "d7fe74ac-65b8-4ade-875f-ccd92759a70f", + "dpi": [ + 300, + 300 + ], + "width": 3432, + "format": "JPEG", + "height": 3432, + "sequence": false, + "color_mode": "RGB", + "orientation": 6, + "geo_location": { + "latitude": -1.1884555555555556, + "longitude": 52.66996666666667 + }, + "datetime_original": "2020-06-07T14:38:16Z", + "hash": "e98d9466a33a9c8b" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://ucarecdn.com/d7fe74ac-65b8-4ade-875f-ccd92759a70f/-/json", + "generated": true + } + ] + } + }, + { + "path": "/:uuid/-/json", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://ucarecdn.com/:uuid/-/json", + "generated": true + } + ] + } + } + ] + }, + "subpackage_fileInformation.fileInfoJsonp": { + "id": "subpackage_fileInformation.fileInfoJsonp", + "namespace": [ + "subpackage_fileInformation" + ], + "description": "Same as the example above, but it returns data as the\n`application/javascript` type.\nThe callback name should always be `uploadcare_callback`. It should\nreceive the two following arguments: `id` and a response object.\nFor original files, id is equivalent to their UUIDs.\nFor processed files, `id` is equivalent to their URLs, excluding\nthe last operation, `jsonp`.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/-/jsonp" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://ucarecdn.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique file identifier" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:File" + } + } + }, + "errors": [ + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/d7fe74ac-65b8-4ade-875f-ccd92759a70f/-/jsonp", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "d7fe74ac-65b8-4ade-875f-ccd92759a70f" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "d7fe74ac-65b8-4ade-875f-ccd92759a70f", + "dpi": [ + 300, + 300 + ], + "width": 3432, + "format": "JPEG", + "height": 3432, + "sequence": false, + "color_mode": "RGB", + "orientation": 6, + "geo_location": { + "latitude": -1.1884555555555556, + "longitude": 52.66996666666667 + }, + "datetime_original": "2020-06-07T14:38:16Z", + "hash": "e98d9466a33a9c8b" + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://ucarecdn.com/d7fe74ac-65b8-4ade-875f-ccd92759a70f/-/jsonp", + "generated": true + } + ] + } + }, + { + "path": "/:uuid/-/jsonp", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://ucarecdn.com/:uuid/-/jsonp", + "generated": true + } + ] + } + } + ] + }, + "subpackage_fileNames.fileWithName": { + "id": "subpackage_fileNames.fileWithName", + "namespace": [ + "subpackage_fileNames" + ], + "description": "You can set an optional filename that users will see instead of\nthe original name.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "filename" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://ucarecdn.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique file identifier" + }, + { + "key": "filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An optional filename that users will see instead of the original name." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "fileDownload" + } + }, + "examples": [ + { + "path": "/d7fe74ac-65b8-4ade-875f-ccd92759a70f/cat.jpg", + "responseStatusCode": 204, + "pathParameters": { + "uuid": "d7fe74ac-65b8-4ade-875f-ccd92759a70f", + "filename": "cat.jpg" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://ucarecdn.com/d7fe74ac-65b8-4ade-875f-ccd92759a70f/cat.jpg", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_:FileColorMode": { + "name": "FileColorMode", + "description": "Image color mode.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RGB" + }, + { + "value": "RGBA" + }, + { + "value": "RGBa" + }, + { + "value": "RGBX" + }, + { + "value": "L" + }, + { + "value": "LA" + }, + { + "value": "La" + }, + { + "value": "P" + }, + { + "value": "PA" + }, + { + "value": "CMYK" + }, + { + "value": "YCbCr" + }, + { + "value": "HSV" + }, + { + "value": "LAB" + } + ] + } + }, + "type_:FileGeoLocation": { + "name": "FileGeoLocation", + "description": "Geo-location of image from EXIF.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "latitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location latitude." + }, + { + "key": "longitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location longitude." + } + ] + } + }, + "type_:File": { + "name": "File", + "description": "File object.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + }, + { + "key": "dpi", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + "description": "Image DPI for two dimensions." + }, + { + "key": "width", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Image width in pixels." + }, + { + "key": "format", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Image format." + }, + { + "key": "height", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Image height in pixels." + }, + { + "key": "sequence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Set to true if a file contains a sequence of images (GIF for example)." + }, + { + "key": "color_mode", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FileColorMode" + } + }, + "description": "Image color mode." + }, + { + "key": "orientation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Image orientation from EXIF." + }, + { + "key": "geo_location", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FileGeoLocation" + } + }, + "description": "Geo-location of image from EXIF." + }, + { + "key": "datetime_original", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Image date and time from EXIF. Please be aware that this data is not always formatted and displayed exactly as it appears in the EXIF." + }, + { + "key": "hash", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "File info response includes a value of a perceptual hash calculated\nusing pixel contents of an image. Perceptual hashing is a common\nfingerprinting technique to quickly compare images and find duplicates\nor similar images. Uploadcare automatically calculates a 64-bit long\nperceptual hash value and returns it as a HEX string. It's easy to find\nimage duplicates by quickly comparing their perceptual hash values.\nTo find similar images, it's important to compare perceptual hash values\nbitwise (Hamming distance).\nA small number of unmatched bits (e.g., up to 8 bits) will correspond\nto subtle changes in the visual contents, while non-similar images\nwill usually have more than 8 different bits." + } + ] + } + } + }, + "subpackages": { + "subpackage_fileInformation": { + "id": "subpackage_fileInformation", + "name": "File information" + }, + "subpackage_fileNames": { + "id": "subpackage_fileNames", + "name": "File names" + } + }, + "auths": {} + }, + { + "id": "15c16fe3-9b9c-4a04-ae4f-f9749d504bc7", + "endpoints": { + "subpackage_upload.baseUpload": { + "id": "subpackage_upload.baseUpload", + "namespace": [ + "subpackage_upload" + ], + "description": "Direct file uploads comply with the [RFC 7578](https://www.rfc-editor.org/rfc/rfc7578) standard.\nIn other words, you can perform a direct upload by making an HTTP POST request with the Content-Type\nheader set to `multipart/form-data`.\n\n**Note**: Direct file uploads support files smaller than 100 megabytes only.\nIf you would like to upload larger files, please use [Multipart Uploads](/api-refs/upload-api/#operation/multipartFileUploadStart) instead.\n\nFile upload example with curl:\n\n```\ncurl -F \"UPLOADCARE_PUB_KEY=YOUR_PUBLIC_KEY\" -F \"my_file.jpg=@my_file.jpg\" \"https://upload.uploadcare.com/base/\"\n```", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/base" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "formData", + "fields": [ + { + "type": "property", + "key": "UPLOADCARE_PUB_KEY", + "valueShape": { + "type": "id", + "id": "type_:ProjectPublicKeyType" + } + }, + { + "type": "property", + "key": "UPLOADCARE_STORE", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StoreType" + } + } + }, + { + "type": "file", + "key": "{filename}", + "isOptional": false + }, + { + "type": "property", + "key": "metadata[{key}]", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:MetadataValue" + } + } + }, + { + "type": "property", + "key": "signature", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SignatureType" + } + } + }, + { + "type": "property", + "key": "expire", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExpireType" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_upload:BaseUploadResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 413, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/base", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "caa9d29da887ee88ffe6", + "metadata[{key}]": "#/components/examples/metadataValue/value", + "signature": "04b29480233f4def5c875875b6bdc3b1", + "expire": 1454902434 + } + }, + "responseBody": { + "type": "json", + "value": { + "filename": "filename" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { base } from '@uploadcare/upload-client'\n\n// fileData must be `Blob` or `File` or `Buffer`\nconst result = await base(\n fileData,\n {\n publicKey: 'YOUR_PUBLIC_KEY',\n store: 'auto',\n metadata: {\n subsystem: 'uploader',\n pet: 'cat'\n }\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "fromPath(__DIR__ . '/squirrel.jpg', null, null, 'auto', [\n 'system' => 'php-uploader',\n 'pet' => 'cat',\n]);\necho \\sprintf(\"URL: %s, ID: %s, Mime type: %s\\n\", $fileInfo->getUrl(), $fileInfo->getUuid(), $fileInfo->getMimeType());\nforeach ($fileInfo->getMetadata() as $key => $value) {\n echo \\sprintf(\"%s: %s\\n\", $key, $value);\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, File\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nwith open('test1.txt', 'rb') as file_object:\n ucare_file = uploadcare.upload(file_object)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nsource_file = File.open('image.png')\nuploaded_file = Uploadcare::Uploader.upload(source_file, store: auto)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nguard let url = Bundle.main.url(forResource: \"squirrel\", withExtension: \"jpg\"),\n let data = try? Data(contentsOf: url) else { return }\nlet metadata = [\"subsystem\": \"uploader\", \"pet\": \"cat\"]\n\nlet file = try await uploadcare.uploadFile(data, withName: \"random_file_name.jpg\", store: .auto) { progress in\n print(\"progress: \\(progress)\")\n}\nprkint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval uri = \"content://com.android.providers.media.documents/document/image%3A1000001178\".toUri()\nval file = FileUploader(uploadcare, uri = uri, context = context).upload()\nLog.d(\"TAG\", file.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/base \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"caa9d29da887ee88ffe6\",\n \"metadata[{key}]\": \"#/components/examples/metadataValue/value\",\n \"signature\": \"04b29480233f4def5c875875b6bdc3b1\",\n \"expire\": 1454902434\n}'", + "generated": true + } + ] + } + }, + { + "path": "/base", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/base \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/base", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/base \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/base", + "responseStatusCode": 413, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/base \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/base", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/base \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_upload.multipartFileUploadStart": { + "id": "subpackage_upload.multipartFileUploadStart", + "namespace": [ + "subpackage_upload" + ], + "description": "Multipart uploads should be used if you need to upload files larger than 100 megabytes or if you want to\nexplicitly trigger [AWS S3 Transfer Acceleration](https://aws.amazon.com/s3/transfer-acceleration/).\nWhen you use Multipart Uploads your files go straight to AWS S3 bypassing our upload instances.\n\nTo upload large files, 3 requests are sent in sequence:\n\n1. `/multipart/start/`\n2. ``\n3. `/multipart/complete/`.\n\n**Note**: Multipart uploads support files larger than 10 megabytes only.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/multipart/start" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "UPLOADCARE_PUB_KEY", + "valueShape": { + "type": "id", + "id": "type_:ProjectPublicKeyType" + } + }, + { + "key": "UPLOADCARE_STORE", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StoreType" + } + } + }, + { + "key": "filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Original file name of the uploaded file" + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Precise file size of the uploaded file (in bytes).\n**Note**: The size should not exceed max file size cap for your project.\n" + }, + { + "key": "part_size", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Multipart Uploads expect that you will split the uploaded file into equally sized\nparts (except for the last part) and then will upload them to AWS S3 (possibly in parallel).\nBy default, we assume that you will upload the files in 5 megabyte chunks,\nso we return a list of presigned AWS S3 URLs accordingly.\nIf you intend to upload large files (for example, larger than a gigabyte),\nwe recommend to bump the part size and to pass the expected chunk size\nto us as a value of the `part_size` parameter (in bytes).\n" + }, + { + "key": "content_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File's MIME-type." + }, + { + "key": "metadata[{key}]", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:MetadataValue" + } + } + }, + { + "key": "signature", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SignatureType" + } + } + }, + { + "key": "expire", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExpireType" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_upload:MultipartFileUploadStartResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/multipart/start", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "caa9d29da887ee88ffe6", + "filename": "filename", + "size": 1, + "content_type": "content_type", + "metadata[{key}]": "#/components/examples/metadataValue/value", + "signature": "04b29480233f4def5c875875b6bdc3b1", + "expire": 1454902434 + } + }, + "responseBody": { + "type": "json", + "value": { + "uuid": "67947755-1584-4e3f-902b-d4e2bf76a841", + "parts": [ + "", + "", + "", + "", + "" + ] + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { multipartStart } from '@uploadcare/upload-client'\n\nconst result = await multipartStart(\n 27796904,\n {\n publicKey: 'YOUR_PUBLIC_KEY',\n store: 'auto',\n fileName: 'myfile.mp4',\n contentType: 'video/mp4',\n metadata: {\n subsystem: 'uploader',\n pet: 'cat'\n }\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nfromResource($handle, null, null, 'auto', [\n 'size' => \\filesize($path), // The \"size\" is the metadata key\n]);\necho \\sprintf('File uploaded. ID is \\'%s\\'', $response->getUuid());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nfrom pyuploadcare import Uploadcare, File\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nwith open('test1.txt', 'rb') as file_object:\n ucare_file = uploadcare.multipart_upload(file_object)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nrequire 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nsource_file = File.open('image.png')\nuploaded_file = Uploadcare::Uploader.upload(source_file, store: auto)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nimport Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nguard let url = Bundle.main.url(forResource: \"Mona_Lisa_23mb\", withExtension: \"jpg\"),\n let data = try? Data(contentsOf: url) else { return }\n\nlet metadata = [\"subsystem\": \"uploader\", \"pet\": \"cat\"]\nlet onProgress: (Double)->Void = { (progress) in\n print(\"progress: \\(progress)\")\n}\n\nlet file = try await uploadcare.uploadAPI.multipartUpload(data, withName: \"Mona_Lisa_big.jpg\", store: .auto, metadata: metadata, onProgress)\nprint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval uri = \"content://com.android.providers.media.documents/document/image%3A1000001178\".toUri()\nval file = FileUploader(uploadcare, uri = uri, context = context).upload()\nLog.d(\"TAG\", file.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/start \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"caa9d29da887ee88ffe6\",\n \"filename\": \"filename\",\n \"size\": 1,\n \"content_type\": \"content_type\",\n \"metadata[{key}]\": \"#/components/examples/metadataValue/value\",\n \"signature\": \"04b29480233f4def5c875875b6bdc3b1\",\n \"expire\": 1454902434\n}'", + "generated": true + } + ] + } + }, + { + "path": "/multipart/start", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string", + "filename": "string", + "size": 0, + "content_type": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/start \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\",\n \"filename\": \"string\",\n \"size\": 0,\n \"content_type\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/multipart/start", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string", + "filename": "string", + "size": 0, + "content_type": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/start \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\",\n \"filename\": \"string\",\n \"size\": 0,\n \"content_type\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/multipart/start", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string", + "filename": "string", + "size": 0, + "content_type": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/start \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\",\n \"filename\": \"string\",\n \"size\": 0,\n \"content_type\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_upload.multipartFileUploadPart": { + "id": "subpackage_upload.multipartFileUploadPart", + "namespace": [ + "subpackage_upload" + ], + "description": "The second phase is about uploading the file parts to the presigned upload URLs returned from the\n`/multipart/start/` endpoint.\n\nEach uploaded part should be at least 5 MiB (5242880 bytes) in size except for the last one, which can be smaller.\nYou can upload the file parts in parallel provided that the byte order stays unchanged.\n\n**Note**: You MUST define `Content-Type` header for your data.", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "request": { + "contentType": "application/octet-stream", + "body": { + "type": "bytes", + "isOptional": false, + "contentType": "application/octet-stream" + } + }, + "examples": [ + { + "path": "/", + "responseStatusCode": 204, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://upload.uploadcare.com/ \\\n -H \"Content-Type: application/octet-stream\"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_upload.multipartFileUploadComplete": { + "id": "subpackage_upload.multipartFileUploadComplete", + "namespace": [ + "subpackage_upload" + ], + "description": "Once all the file parts have been uploaded successfully, complete the\nupload session to assemble all the file parts into a single resulting file.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/multipart/complete" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "UPLOADCARE_PUB_KEY", + "valueShape": { + "type": "id", + "id": "type_:ProjectPublicKeyType" + } + }, + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File's UUID from the `/multipart/start/` endpoint." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FileUploadInfo" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/multipart/complete", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "caa9d29da887ee88ffe6", + "uuid": "uuid" + } + }, + "responseBody": { + "type": "json", + "value": { + "uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "file_id": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "size": 2667636, + "total": 2667636, + "done": 2667636, + "original_filename": "IMG-0412_123.JPG", + "filename": "IMG0412_123.JPG", + "mime_type": "image/jpeg", + "is_image": true, + "is_stored": true, + "is_ready": true, + "image_info": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 4032, + "width": 3024, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video_info": { + "duration": 261827, + "format": "mp4", + "bitrate": 393, + "audio": { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": "2" + }, + "video": { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 4032, + "width": 3024, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + }, + "s3_bucket": "custom-s3-bucket-name" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { multipartComplete } from '@uploadcare/upload-client'\n\nconst result = await multipartComplete(\n '67947755-1584-4e3f-902b-d4e2bf76a841',\n {\n publicKey: 'YOUR_PUBLIC_KEY'\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nfromResource($handle, null, null, 'auto', [\n 'size' => \\filesize($path), // The \"size\" is the metadata key\n]);\necho \\sprintf('File uploaded. ID is \\'%s\\'', $response->getUuid());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nfrom pyuploadcare import Uploadcare, File\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nwith open('test1.txt', 'rb') as file_object:\n ucare_file = uploadcare.multipart_upload(file_object)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nrequire 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nsource_file = File.open('image.png')\nuploaded_file = Uploadcare::Uploader.upload(source_file, store: auto)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "// Uploadcare lib provides high level API for multipart uploads that does everything for you\n\nimport Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nguard let url = Bundle.main.url(forResource: \"Mona_Lisa_23mb\", withExtension: \"jpg\"),\n let data = try? Data(contentsOf: url) else { return }\n\nlet metadata = [\"subsystem\": \"uploader\", \"pet\": \"cat\"]\nlet onProgress: (Double)->Void = { (progress) in\n print(\"progress: \\(progress)\")\n}\n\nlet file = try await uploadcare.uploadAPI.multipartUpload(data, withName: \"Mona_Lisa_big.jpg\", store: .auto, metadata: metadata, onProgress)\nprint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval uri = \"content://com.android.providers.media.documents/document/image%3A1000001178\".toUri()\nval file = FileUploader(uploadcare, uri = uri, context = context).upload()\nLog.d(\"TAG\", file.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/complete \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"caa9d29da887ee88ffe6\",\n \"uuid\": \"uuid\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/multipart/complete", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string", + "uuid": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/complete \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\",\n \"uuid\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/multipart/complete", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string", + "uuid": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/complete \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\",\n \"uuid\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/multipart/complete", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "UPLOADCARE_PUB_KEY": "string", + "uuid": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/multipart/complete \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"UPLOADCARE_PUB_KEY\": \"string\",\n \"uuid\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_upload.fromURLUpload": { + "id": "subpackage_upload.fromURLUpload", + "namespace": [ + "subpackage_upload" + ], + "description": "Uploadcare can fetch a file from a publicly available URL and then automatically upload the\nfetched file to your project.\n\n#### Upload tokens\n\nRequests to the endpoint return a JSON dictionary with a `token` that can be further used\nto [check the status](/api-refs/upload-api/#operation/fromURLUploadStatus) of the upload\nrequest.\n\n**Note:** The token is not a file ID and can't be used to address the file directly.\nThe actual file ID should be retrieved by calling the `/from_url/status/` endpoint.\n\n#### Duplicates prevention\n\nBy default, every call to the `/from_url/` endpoint with the same `source_url` results in\na new upload leading to file duplication.\n\nIf you would like Uploadcare to keep track of the requested URLs and avoid the duplicate\nuploads, pass the `save_URL_duplicates` and `check_URL_duplicates` parameters described below.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/from_url" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "pub_key", + "valueShape": { + "type": "id", + "id": "type_:ProjectPublicKeyType" + } + }, + { + "key": "source_url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Source URL of the file to fetch and upload.\n\n**Note**: The URL should point to a resource publicly available via HTTP/HTTPS.\n" + }, + { + "key": "store", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:StoreType" + } + } + }, + { + "key": "filename", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Sets the file name of the resource fetched from the source URL.\nIf not defined, the file name is obtained from either HTTP\nresponse headers or the `source_url`'s path.\n\n**Note:** The filename will be sanitized to only contain the following symbols:\n`abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789._`.\n" + }, + { + "key": "check_URL_duplicates", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_upload:FromUrlUploadRequestCheckUrlDuplicates" + } + }, + "description": "If set to \"1\", enables the `source_url` duplicates prevention.\nSpecifically, if the `source_url` had already been fetched and uploaded previously,\nthis request will return information about the already uploaded file.\n" + }, + { + "key": "save_URL_duplicates", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_upload:FromUrlUploadRequestSaveUrlDuplicates" + } + }, + "description": "Determines if the requested `source_url` should be kept in the history of\nfetched/uploaded URLs. If the value is not defined explicitly, it is set\nto the value of the `check_URL_duplicates` parameter.\n" + }, + { + "key": "metadata[{key}]", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:MetadataValue" + } + } + }, + { + "key": "signature", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SignatureType" + } + } + }, + { + "key": "expire", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExpireType" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_upload:FromUrlUploadResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/from_url", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "pub_key": "caa9d29da887ee88ffe6", + "source_url": "source_url", + "metadata[{key}]": "#/components/examples/metadataValue/value", + "signature": "04b29480233f4def5c875875b6bdc3b1", + "expire": 1454902434 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "token", + "token": "945ebb27-1fd6-46c6-a859-b9893712d650" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { fromUrl } from '@uploadcare/upload-client'\n\nconst result = await fromUrl(\n 'https://source.unsplash.com/featured',\n {\n publicKey: 'YOUR_PUBLIC_KEY',\n metadata: {\n subsystem: 'uploader',\n pet: 'cat'\n }\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "fromUrl($url, null, null, 'auto', [\n 'action' => 'upload from URL', // The \"Action\" is the metadata key\n 'checkDuplicates' => true,\n 'storeDuplicates' => false,\n]);\necho \\sprintf('Upload from URL \\'%s\\' has been started. Token is %s', $url, $token);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nucare_file = uploadcare.upload_from_url_sync(\n \"https://source.unsplash.com/featured\",\n check_duplicates=True,\n save_duplicates=False\n)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\n\nsource_url = \"https://source.unsplash.com/featured\"\nuploaded_file = Uploadcare::Uploader.upload(source_url, store: auto)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet url = URL(string: \"https://source.unsplash.com/featured\")!\nlet task = UploadFromURLTask(sourceUrl: url)\n .store(.auto)\n .setMetadata(\"uploader\", forKey: \"subsystem\")\n .setMetadata(\"cat\", forKey: \"pet\")\n\nlet file = try await uploadcare.uploadAPI.uploadAndWaitForCompletion(task: task)\nprint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval uploader = UrlUploader(\n client = uploadcare,\n sourceUrl = \"https://source.unsplash.com/featured\"\n)\nval file = uploader.upload()\nLog.d(\"TAG\", file.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/from_url \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"pub_key\": \"caa9d29da887ee88ffe6\",\n \"source_url\": \"source_url\",\n \"metadata[{key}]\": \"#/components/examples/metadataValue/value\",\n \"signature\": \"04b29480233f4def5c875875b6bdc3b1\",\n \"expire\": 1454902434\n}'", + "generated": true + } + ] + } + }, + { + "path": "/from_url", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "pub_key": "string", + "source_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/from_url \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"pub_key\": \"string\",\n \"source_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/from_url", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "pub_key": "string", + "source_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/from_url \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"pub_key\": \"string\",\n \"source_url\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/from_url", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "pub_key": "string", + "source_url": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/from_url \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"pub_key\": \"string\",\n \"source_url\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_upload.fromURLUploadStatus": { + "id": "subpackage_upload.fromURLUploadStatus", + "namespace": [ + "subpackage_upload" + ], + "description": "The endpoint notifies about the progress of the task by changing the value of the `status` field:\n\n- the field is set to `waiting` initially\n- once the system starts processing the request, the field is set to `progress`\n- if the file is fetched and uploaded successfully, the `status` field is set to `success`\n and the endpoint returns a JSON object holding information about the uploaded file\n- if the system fails to fetch/upload the file, the `status` field is set to `error` and\n the `error` field is set to the cause of the error.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/from_url/status" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Token returned by the `/from_url/` endpoint that identifies a request to fetch/upload a file from a URL." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_upload:FromUrlUploadStatusResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/from_url/status", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "token": "token" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "waiting" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { fromUrlStatus } from '@uploadcare/upload-client'\n\nconst result = await fromUrlStatus(\n '945ebb27-1fd6-46c6-a859-b9893712d650',\n {\n publicKey: 'YOUR_PUBLIC_KEY'\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "checkStatus('945ebb27-1fd6-46c6-a859-b9893712d650');\necho \\sprintf('Upload status is %s', $status);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, File\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nfile = uploadcare.file_from_url('945ebb27-1fd6-46c6-a859-b9893712d650')\nprint(file.info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\ntoken = '945ebb27-1fd6-46c6-a859-b9893712d650'\nputs Uploadcare::Uploader.get_upload_from_url_status(token)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet status = try await uploadcare.uploadAPI.uploadStatus(forToken: \"945ebb27-1fd6-46c6-a859-b9893712d650\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval status = uploadcare.getFromUrlStatus(token = \"945ebb27-1fd6-46c6-a859-b9893712d650\")\nLog.d(\"TAG\", status.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/from_url/status \\\n -d token=token", + "generated": true + } + ] + } + }, + { + "path": "/from_url/status", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "token": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/from_url/status \\\n -d token=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_upload.fileUploadInfo": { + "id": "subpackage_upload.fileUploadInfo", + "namespace": [ + "subpackage_upload" + ], + "description": "Returns a JSON object with information about an uploaded file (file size, MIME type, metadata, etc).", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/info" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "pub_key", + "valueShape": { + "type": "id", + "id": "type_:ProjectPublicKeyType" + } + }, + { + "key": "file_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File's unique ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:FileUploadInfo" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/info", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "pub_key": "caa9d29da887ee88ffe6", + "file_id": "file_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "file_id": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "size": 2667636, + "total": 2667636, + "done": 2667636, + "original_filename": "IMG-0412_123.JPG", + "filename": "IMG0412_123.JPG", + "mime_type": "image/jpeg", + "is_image": true, + "is_stored": true, + "is_ready": true, + "image_info": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 4032, + "width": 3024, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video_info": { + "duration": 261827, + "format": "mp4", + "bitrate": 393, + "audio": { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": "2" + }, + "video": { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 4032, + "width": 3024, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + }, + "s3_bucket": "custom-s3-bucket-name" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { info } from '@uploadcare/upload-client'\n\nconst result = await info(\n 'be3b4d5e-179d-460e-8a5d-69112ac86cbb',\n {\n publicKey: 'YOUR_PUBLIC_KEY'\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file()->fileInfo(string $uuid);\necho \\sprintf('URL: %s, ID: %s, Mime type: %s', $fileInfo->getUrl(), $fileInfo->getUuid(), $fileInfo->getMimeType());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, File\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nfile = uploadcare.file('740e1b8c-1ad8-4324-b7ec-112c79d8eac2')\nprint(file.info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = '740e1b8c-1ad8-4324-b7ec-112c79d8eac2'\ninfo = Uploadcare::File.info(uuid)\nputs info.inspect\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet file = try await uploadcare.uploadAPI.fileInfo(withFileId: \"740e1b8c-1ad8-4324-b7ec-112c79d8eac2\")\nprint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval file = uploadcare.getUploadedFile(fileId = \"740e1b8c-1ad8-4324-b7ec-112c79d8eac2\")\nLog.d(\"TAG\", file.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/info \\\n -d pub_key=caa9d29da887ee88ffe6 \\\n -d file_id=file_id", + "generated": true + } + ] + } + }, + { + "path": "/info", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "pub_key": "string", + "file_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/info \\\n -d pub_key=string \\\n -d file_id=string", + "generated": true + } + ] + } + }, + { + "path": "/info", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": { + "pub_key": "string", + "file_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/info \\\n -d pub_key=string \\\n -d file_id=string", + "generated": true + } + ] + } + }, + { + "path": "/info", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": { + "pub_key": "string", + "file_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/info \\\n -d pub_key=string \\\n -d file_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_groups.createFilesGroup": { + "id": "subpackage_groups.createFilesGroup", + "namespace": [ + "subpackage_groups" + ], + "description": "Create a file group from a set of already uploaded files.\n\nThe most common use case for creating a file group is when a user uploads\nmultiple files at once and then wants to display them together.\n\n**Note:** A group itself and files within it MUST belong to the same project.\n\n**Note:** Groups are immutable and the only way to add/remove a file to a group\nis to create a new one.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/group" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "request": { + "contentType": "multipart/form-data", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "pub_key", + "valueShape": { + "type": "id", + "id": "type_:ProjectPublicKeyType" + } + }, + { + "key": "files[]", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Set of files you want to add to the group.\nEach element can be a file UUID with or without the applied image\nprocessing operations.\n" + }, + { + "key": "signature", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SignatureType" + } + } + }, + { + "key": "expire", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ExpireType" + } + } + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GroupInfo" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/group", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "pub_key": "caa9d29da887ee88ffe6", + "files[]": [ + "files[]" + ], + "signature": "04b29480233f4def5c875875b6bdc3b1", + "expire": 1454902434 + } + }, + "responseBody": { + "type": "json", + "value": { + "id": "0d712319-b970-4602-850c-bae1ced521a6~1", + "datetime_created": "2018-09-12T10:03:38Z", + "datetime_stored": "2015-09-21T12:39:13Z", + "files_count": 1, + "cdn_url": "https://ucarecdn.com/0d712319-b970-4602-850c-bae1ced521a6~1/", + "url": "https://api.uploadcare.com/groups/0d712319-b970-4602-850c-bae1ced521a6~1/", + "files": [ + { + "default_effects": "resize/x800/", + "uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "file_id": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "size": 2667636, + "total": 2667636, + "done": 2667636, + "original_filename": "IMG-0412_123.JPG", + "filename": "IMG0412_123.JPG", + "mime_type": "image/jpeg", + "image_info": { + "color_mode": "RGB", + "orientation": 6, + "format": "JPEG", + "height": 4032, + "width": 3024, + "sequence": false, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T08:59:50", + "dpi": { + "0": 72, + "1": 72 + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "orientation": 6, + "format": "JPEG", + "height": 4032, + "width": 3024, + "sequence": false, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T08:59:50", + "dpi": { + "0": 72, + "1": 72 + } + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + }, + "is_image": true, + "is_stored": true, + "is_ready": true + } + ] + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { group } from '@uploadcare/upload-client'\n\nconst result = await group(\n [\n 'd6d34fa9-addd-472c-868d-2e5c105f9fcd',\n 'b1026315-8116-4632-8364-607e64fca723/-/resize/x800/'\n ],\n {\n publicKey: 'YOUR_PUBLIC_KEY'\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "groupFiles(['d6d34fa9-addd-472c-868d-2e5c105f9fcd', 'b1026315-8116-4632-8364-607e64fca723/-/resize/x800/']);\necho \\sprintf('Response status is %s', $result->getStatusCode());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, File, FileGroup\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nfile_1 = uploadcare.file('d6d34fa9-addd-472c-868d-2e5c105f9fcd')\nfile_2 = uploadcare.file('b1026315-8116-4632-8364-607e64fca723/-/resize/x800/')\nfile_group = uploadcare.create_file_group([file_1, file_2])\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\n\nuuids = [\n 'd6d34fa9-addd-472c-868d-2e5c105f9fcd',\n 'b1026315-8116-4632-8364-607e64fca723/-/resize/x800/'\n]\ngroup = Uploadcare::Group.create(uuids)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet filesIds = [\"d6d34fa9-addd-472c-868d-2e5c105f9fcd\", \"b1026315-8116-4632-8364-607e64fca723/-/resize/x800/\"]\nlet group = try await uploadAPI.createFilesGroup(fileIds: filesIds)\nprint(group)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval uuids = listOf(\n \"d6d34fa9-addd-472c-868d-2e5c105f9fcd\",\n \"b1026315-8116-4632-8364-607e64fca723/-/resize/x800/\"\n)\nval group = uploadcare.createGroup(fileIds = uuids)\nLog.d(\"TAG\", group.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/group \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"pub_key\": \"caa9d29da887ee88ffe6\",\n \"files[]\": [\n \"files[]\"\n ],\n \"signature\": \"04b29480233f4def5c875875b6bdc3b1\",\n \"expire\": 1454902434\n}'", + "generated": true + } + ] + } + }, + { + "path": "/group", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "pub_key": "string", + "files[]": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/group \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"pub_key\": \"string\",\n \"files[]\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + }, + { + "path": "/group", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "pub_key": "string", + "files[]": [ + "string" + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://upload.uploadcare.com/group \\\n -H \"Content-Type: multipart/form-data\" \\\n -d '{\n \"pub_key\": \"string\",\n \"files[]\": [\n \"string\"\n ]\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_groups.filesGroupInfo": { + "id": "subpackage_groups.filesGroupInfo", + "namespace": [ + "subpackage_groups" + ], + "description": "Returns a JSON object with information about a file group (when the group was created,\nnumber of the files in the group, etc).", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/group/info" + } + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://upload.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "pub_key", + "valueShape": { + "type": "id", + "id": "type_:ProjectPublicKeyType" + } + }, + { + "key": "group_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Group's unique ID. Group IDs look like `UUID~N`, where the `~N` part reflects the number of the files in the group." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GroupInfo" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/group/info", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "pub_key": "caa9d29da887ee88ffe6", + "group_id": "group_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": "0d712319-b970-4602-850c-bae1ced521a6~1", + "datetime_created": "2018-09-12T10:03:38Z", + "datetime_stored": "2015-09-21T12:39:13Z", + "files_count": 1, + "cdn_url": "https://ucarecdn.com/0d712319-b970-4602-850c-bae1ced521a6~1/", + "url": "https://api.uploadcare.com/groups/0d712319-b970-4602-850c-bae1ced521a6~1/", + "files": [ + { + "default_effects": "resize/x800/", + "uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "file_id": "be3b4d5e-179d-460e-8a5d-69112ac86cbb", + "size": 2667636, + "total": 2667636, + "done": 2667636, + "original_filename": "IMG-0412_123.JPG", + "filename": "IMG0412_123.JPG", + "mime_type": "image/jpeg", + "image_info": { + "color_mode": "RGB", + "orientation": 6, + "format": "JPEG", + "height": 4032, + "width": 3024, + "sequence": false, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T08:59:50", + "dpi": { + "0": 72, + "1": 72 + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "orientation": 6, + "format": "JPEG", + "height": 4032, + "width": 3024, + "sequence": false, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T08:59:50", + "dpi": { + "0": 72, + "1": 72 + } + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + }, + "is_image": true, + "is_stored": true, + "is_ready": true + } + ] + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import { groupInfo } from '@uploadcare/upload-client'\n\nconst result = await groupInfo(\n '0d712319-b970-4602-850c-bae1ced521a6~1',\n {\n publicKey: 'YOUR_PUBLIC_KEY'\n }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "groupInfo('0d712319-b970-4602-850c-bae1ced521a6~1');\necho $groupInfo->getBody()->getContents();\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, FileGroup\n\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\nfile_group = uploadcare.file_group('0d712319-b970-4602-850c-bae1ced521a6~1')\nprint(file_group.info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = '0d712319-b970-4602-850c-bae1ced521a6~1'\ninfo = Uploadcare::Group.info(uuid)\nputs info.inspect\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet group = try await uploadcare.uploadAPI.filesGroupInfo(groupId: \"0d712319-b970-4602-850c-bae1ced521a6~1\")\nprint(group)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval group = uploadcare.getUploadedGroup(groupId = \"0d712319-b970-4602-850c-bae1ced521a6~1\")\nLog.d(\"TAG\", group.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/group/info \\\n -d pub_key=caa9d29da887ee88ffe6 \\\n -d group_id=group_id", + "generated": true + } + ] + } + }, + { + "path": "/group/info", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "pub_key": "string", + "group_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/group/info \\\n -d pub_key=string \\\n -d group_id=string", + "generated": true + } + ] + } + }, + { + "path": "/group/info", + "responseStatusCode": 403, + "pathParameters": {}, + "queryParameters": { + "pub_key": "string", + "group_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/group/info \\\n -d pub_key=string \\\n -d group_id=string", + "generated": true + } + ] + } + }, + { + "path": "/group/info", + "responseStatusCode": 404, + "pathParameters": {}, + "queryParameters": { + "pub_key": "string", + "group_id": "string" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://upload.uploadcare.com/group/info \\\n -d pub_key=string \\\n -d group_id=string", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_upload:BaseUploadResponse": { + "name": "BaseUploadResponse", + "description": "JSON object where the key is the file name of the uploaded file and\nthe value is the unique ID of the file on our systems.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "filename", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_upload:MultipartFileUploadStartResponse": { + "name": "MultipartFileUploadStartResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File's UUID." + }, + { + "key": "parts", + "valueShape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_upload:FromUrlUploadRequestCheckUrlDuplicates": { + "name": "FromUrlUploadRequestCheckUrlDuplicates", + "description": "If set to \"1\", enables the `source_url` duplicates prevention.\nSpecifically, if the `source_url` had already been fetched and uploaded previously,\nthis request will return information about the already uploaded file.", + "shape": { + "type": "enum", + "values": [ + { + "value": "0" + }, + { + "value": "1" + } + ] + } + }, + "type_upload:FromUrlUploadRequestSaveUrlDuplicates": { + "name": "FromUrlUploadRequestSaveUrlDuplicates", + "description": "Determines if the requested `source_url` should be kept in the history of\nfetched/uploaded URLs. If the value is not defined explicitly, it is set\nto the value of the `check_URL_duplicates` parameter.", + "shape": { + "type": "enum", + "values": [ + { + "value": "0" + }, + { + "value": "1" + } + ] + } + }, + "type_upload:FromUrlUploadResponse": { + "name": "FromUrlUploadResponse", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "From Url Upload Response Schema", + "shape": { + "type": "id", + "id": "type_:FromUrlUploadResponseSchema" + } + }, + { + "displayName": "File Upload Info From Url", + "shape": { + "type": "id", + "id": "type_:FileUploadInfoFromUrl" + } + } + ] + } + }, + "type_upload:FromUrlUploadStatusResponse": { + "name": "FromUrlUploadStatusResponse", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "File Upload Info Waiting Status", + "shape": { + "type": "id", + "id": "type_:FileUploadInfoWaitingStatus" + } + }, + { + "displayName": "File Upload Info Progress Status", + "shape": { + "type": "id", + "id": "type_:FileUploadInfoProgressStatus" + } + }, + { + "displayName": "File Upload Info Success Status", + "shape": { + "type": "id", + "id": "type_:FileUploadInfoSuccessStatus" + } + }, + { + "displayName": "File Upload Info Error Status", + "shape": { + "type": "id", + "id": "type_:FileUploadInfoErrorStatus" + } + }, + { + "displayName": "File Upload Info Unknown Status", + "shape": { + "type": "id", + "id": "type_:FileUploadInfoUnknownStatus" + } + } + ] + } + }, + "type_:SignatureType": { + "name": "SignatureType", + "description": "`signature` must be sent along with your upload request if you would like to use signed uploads.\nThe signature should be generated on your backend.\n**Note**: the process requires knowledge of your Uploadcare Project's Secret key.\nSee [signed uploads](https://uploadcare.com/docs/security/secure-uploads/) for details.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:ExpireType": { + "name": "ExpireType", + "description": "`expire` must be sent along with your upload request if you would like to use signed uploads.\nThe parameter defines the time during which your signature is valid. It's a UNIX timestamp.\nSee [signed uploads](https://uploadcare.com/docs/security/secure-uploads/) for details.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + "type_:StoreType": { + "name": "StoreType", + "description": "Determines if an uploaded file should be marked as temporary or permanent.\n\nThe parameter can have the following values:\n\n- `0` - do not mark an uploaded file as stored and remove it after 24 hours\n- `1` - mark the uploaded file as stored\n- `auto` - delegate the choice of the file-storing behavior to a project-wide setting called\n [auto-store](https://app.uploadcare.com/projects/-/settings/#storage).\n\nThe default value depends on the user registration date.\n\nFor all users registered after February 12, 2024 (UTC 13:30), the default value is `auto`.\nFile-storing behavior depends entirely on what is set in the\n[storage settings](https://app.uploadcare.com/projects/-/settings/#storage) in the Dashboard.\n\nFor users registered before February 12, 2024, the default value is `0`.\nTo ensure that file storage in the project matches the settings in the Dashboard,\nchange the value to `auto`.", + "shape": { + "type": "enum", + "values": [ + { + "value": "0" + }, + { + "value": "1" + }, + { + "value": "auto" + } + ] + } + }, + "type_:ProjectPublicKeyType": { + "name": "ProjectPublicKeyType", + "description": "Public key identifying an Uploadcare project your uploads will go to.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileUploadInfo": { + "name": "FileUploadInfo", + "description": "Information about an uploaded file.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File's unique ID." + }, + { + "key": "file_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Same as `uuid`" + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "File's size in bytes." + }, + { + "key": "total", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Same as `size`." + }, + { + "key": "done", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Same as `size`." + }, + { + "key": "original_filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Original file of the uploaded file." + }, + { + "key": "filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Sanitized `original_filename`." + }, + { + "key": "mime_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File's MIME-type." + }, + { + "key": "image_info", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageInfo" + } + } + }, + { + "key": "video_info", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LegacyVideoInfo" + } + } + }, + { + "key": "content_info", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ContentInfo" + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Metadata" + } + } + }, + { + "key": "is_image", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if the uploaded file is an image of a supported file format." + }, + { + "key": "is_stored", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if the file has been marked as stored." + }, + { + "key": "is_ready", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "True if the file is ready to be fetched from Uploadcare's CDN." + }, + { + "key": "s3_bucket", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of an AWS S3 bucket where the file is stored. Only available if you associate a Foreign Storage Bucket with your project." + } + ] + } + }, + "type_:FileUploadInfoWaitingStatus": { + "name": "FileUploadInfoWaitingStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "waiting" + } + } + } + } + ] + } + }, + "type_:FileUploadInfoProgressStatus": { + "name": "FileUploadInfoProgressStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "progress" + } + } + } + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The expected size of the fetched file (in bytes).\n\n**Note:** the value can be missing if the server we are fetching the file from\ndoes not provide the information or if the server is returning the file in, for\nexample, [compressed form](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding)." + }, + { + "key": "done", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "How many bytes of the file have been fetched so far." + } + ] + } + }, + "type_:FileUploadInfoSuccessStatus": { + "name": "FileUploadInfoSuccessStatus", + "shape": { + "type": "object", + "extends": [ + "type_:FileUploadInfo" + ], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "success" + } + } + } + } + ] + } + }, + "type_:FileUploadInfoErrorStatus": { + "name": "FileUploadInfoErrorStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "error" + } + } + } + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Human readable description of the issue with the fetch/upload task." + }, + { + "key": "error_code", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Machine readable error code.\n\nNote: See the [Errors > FromURL upload errors](#tag/Errors) section of this\npage for a full list of all possible error codes." + } + ] + } + }, + "type_:FileUploadInfoUnknownStatus": { + "name": "FileUploadInfoUnknownStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "unknown" + } + } + } + } + ] + } + }, + "type_:FileUploadInfoFromUrl": { + "name": "FileUploadInfoFromUrl", + "shape": { + "type": "object", + "extends": [ + "type_:FileUploadInfo" + ], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "file_info" + } + } + } + } + ] + } + }, + "type_:FromUrlUploadResponseSchema": { + "name": "FromUrlUploadResponseSchema", + "description": "`/from_url/` upload response.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "token" + } + } + } + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Token to identify a `/from_url/` request." + } + ] + } + }, + "type_:GroupInfo": { + "name": "GroupInfo", + "description": "File group information object.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Group's unique ID." + }, + { + "key": "datetime_created", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "ISO-8601 date and time when the group was created." + }, + { + "key": "datetime_stored", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "ISO-8601 date and time when the group was marked as stored." + }, + { + "key": "files_count", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Number of the files in the group." + }, + { + "key": "cdn_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Group's CDN URL." + }, + { + "key": "url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Group's API resource URL. See the [REST API](/api-refs/rest-api/) documentation for details." + }, + { + "key": "files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + "description": "The list of files in the group. An array may contain null values if a file has been removed." + } + ] + } + }, + "type_:MetadataValue": { + "name": "MetadataValue", + "description": "Arbitrary metadata associated with the file.\nSee [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api-refs/rest-api/v0.7.0/#tag/File-metadata) for more information.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:AutoStoreDisabledError": { + "name": "AutoStoreDisabledError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UploadcarePublicKeyRequiredError": { + "name": "UploadcarePublicKeyRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:PublicKeyRequiredError": { + "name": "PublicKeyRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UploadcarePublicKeyInvalidError": { + "name": "UploadcarePublicKeyInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:PublicKeyInvalidError": { + "name": "PublicKeyInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:ProjectPublicKeyRemovedError": { + "name": "ProjectPublicKeyRemovedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:AccountBlockedError": { + "name": "AccountBlockedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:AccountUnpaidError": { + "name": "AccountUnpaidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UploadFailedError": { + "name": "UploadFailedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:AccountLimitsExceededError": { + "name": "AccountLimitsExceededError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:SignatureExpirationError": { + "name": "SignatureExpirationError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:SignatureInvalidError": { + "name": "SignatureInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:RequestFiledsNumberLimitExceededError": { + "name": "RequestFiledsNumberLimitExceededError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:PostRequestParserFailedError": { + "name": "PostRequestParserFailedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:NullCharactersForbiddenError": { + "name": "NullCharactersForbiddenError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataKeyDuplicatedError": { + "name": "FileMetadataKeyDuplicatedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataKeyEmptyError": { + "name": "FileMetadataKeyEmptyError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataKeyForbiddenError": { + "name": "FileMetadataKeyForbiddenError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataKeyLengthTooBigError": { + "name": "FileMetadataKeyLengthTooBigError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataValueEmptyError": { + "name": "FileMetadataValueEmptyError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataValueForbiddenError": { + "name": "FileMetadataValueForbiddenError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataValueLengthTooBigError": { + "name": "FileMetadataValueLengthTooBigError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileMetadataKeysNumberTooBigError": { + "name": "FileMetadataKeysNumberTooBigError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FilesRequiredError": { + "name": "FilesRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileSizeLimitExceededError": { + "name": "FileSizeLimitExceededError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileTypeForbiddenError": { + "name": "FileTypeForbiddenError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileInfectedError": { + "name": "FileInfectedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:RequestParamRequiredError": { + "name": "RequestParamRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartSizeInvalidError": { + "name": "MultipartSizeInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartFileSizeLimitExceededError": { + "name": "MultipartFileSizeLimitExceededError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartFileSizeTooSmallError": { + "name": "MultipartFileSizeTooSmallError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartPartSizeInvalidError": { + "name": "MultipartPartSizeInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartPartSizeTooSmallError": { + "name": "MultipartPartSizeTooSmallError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartPartSizeTooBigError": { + "name": "MultipartPartSizeTooBigError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartFileIdRequiredError": { + "name": "MultipartFileIdRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartFileAlreadyUploadedError": { + "name": "MultipartFileAlreadyUploadedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartUploadSizeTooLargeError": { + "name": "MultipartUploadSizeTooLargeError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartUploadSizeTooSmallError": { + "name": "MultipartUploadSizeTooSmallError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:MultipartFileCompletionFailedError": { + "name": "MultipartFileCompletionFailedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UuidInvalidError": { + "name": "UuidInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:SourceUrlRequiredError": { + "name": "SourceUrlRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UrlParsingFailedError": { + "name": "UrlParsingFailedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UrlSchemeRequiredError": { + "name": "UrlSchemeRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UrlSchemeInvalidError": { + "name": "UrlSchemeInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UrlHostRequiredError": { + "name": "UrlHostRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UrlBlacklistedError": { + "name": "UrlBlacklistedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:HostnameNotFoundError": { + "name": "HostnameNotFoundError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UrlHostMalformedError": { + "name": "UrlHostMalformedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:UrlHostPrivateIpForbiddenError": { + "name": "UrlHostPrivateIpForbiddenError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:TokenRequiredError": { + "name": "TokenRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileIdRequiredError": { + "name": "FileIdRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileIdInvalidError": { + "name": "FileIdInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:FileNotFoundError": { + "name": "FileNotFoundError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:GroupFilesInvalidError": { + "name": "GroupFilesInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:GroupFileUrlParsingFailedError": { + "name": "GroupFileUrlParsingFailedError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:GroupFilesNotFoundError": { + "name": "GroupFilesNotFoundError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:GroupIdRequiredError": { + "name": "GroupIdRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:GroupNotFoundError": { + "name": "GroupNotFoundError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:SignatureRequiredError": { + "name": "SignatureRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:SignatureExpirationRequiredError": { + "name": "SignatureExpirationRequiredError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:SignatureExpirationInvalidError": { + "name": "SignatureExpirationInvalidError", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:ImageInfoColorMode": { + "name": "ImageInfoColorMode", + "description": "Image color mode.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RGB" + }, + { + "value": "RGBA" + }, + { + "value": "RGBa" + }, + { + "value": "RGBX" + }, + { + "value": "L" + }, + { + "value": "LA" + }, + { + "value": "La" + }, + { + "value": "P" + }, + { + "value": "PA" + }, + { + "value": "CMYK" + }, + { + "value": "YCbCr" + }, + { + "value": "HSV" + }, + { + "value": "LAB" + } + ] + } + }, + "type_:ImageInfoGeoLocation": { + "name": "ImageInfoGeoLocation", + "description": "Geo-location of image from EXIF.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "latitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location latitude." + }, + { + "key": "longitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location longitude." + } + ] + } + }, + "type_:ImageInfo": { + "name": "ImageInfo", + "description": "Image metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "color_mode", + "valueShape": { + "type": "id", + "id": "type_:ImageInfoColorMode" + }, + "description": "Image color mode." + }, + { + "key": "orientation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Image orientation from EXIF." + }, + { + "key": "format", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Image format." + }, + { + "key": "sequence", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Set to true if a file contains a sequence of images (GIF for example)." + }, + { + "key": "height", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Image height in pixels." + }, + { + "key": "width", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Image width in pixels." + }, + { + "key": "geo_location", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageInfoGeoLocation" + } + }, + "description": "Geo-location of image from EXIF." + }, + { + "key": "datetime_original", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Image date and time from EXIF. Please be aware that this data is not always formatted and displayed exactly as it appears in the EXIF." + }, + { + "key": "dpi", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + "description": "Image DPI for two dimensions." + } + ] + } + }, + "type_:LegacyVideoInfoAudio": { + "name": "LegacyVideoInfoAudio", + "description": "Audio stream's metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Audio stream's bitrate." + }, + { + "key": "codec", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Audio stream's codec." + }, + { + "key": "sample_rate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Audio stream's sample rate." + }, + { + "key": "channels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Audio stream's number of channels." + } + ] + } + }, + "type_:LegacyVideoInfoVideo": { + "name": "LegacyVideoInfoVideo", + "description": "Video stream's metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "height", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Video stream's image height." + }, + { + "key": "width", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Video stream's image width." + }, + { + "key": "frame_rate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Video stream's frame rate." + }, + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Video stream's bitrate." + }, + { + "key": "codec", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Video stream codec." + } + ] + } + }, + "type_:LegacyVideoInfo": { + "name": "LegacyVideoInfo", + "description": "Video metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "duration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Video file's duration in milliseconds." + }, + { + "key": "format", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Video file's format." + }, + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Video file's bitrate." + }, + { + "key": "audio", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LegacyVideoInfoAudio" + } + }, + "description": "Audio stream's metadata." + }, + { + "key": "video", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:LegacyVideoInfoVideo" + } + }, + "description": "Video stream's metadata." + } + ] + } + }, + "type_:SchemasImageInfoColorMode": { + "name": "SchemasImageInfoColorMode", + "description": "Image color mode.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RGB" + }, + { + "value": "RGBA" + }, + { + "value": "RGBa" + }, + { + "value": "RGBX" + }, + { + "value": "L" + }, + { + "value": "LA" + }, + { + "value": "La" + }, + { + "value": "P" + }, + { + "value": "PA" + }, + { + "value": "CMYK" + }, + { + "value": "YCbCr" + }, + { + "value": "HSV" + }, + { + "value": "LAB" + } + ] + } + }, + "type_:SchemasImageInfoGeoLocation": { + "name": "SchemasImageInfoGeoLocation", + "description": "Geo-location of image from EXIF.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "latitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location latitude." + }, + { + "key": "longitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location longitude." + } + ] + } + }, + "type_:SchemasImageInfo": { + "name": "SchemasImageInfo", + "description": "Image metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "color_mode", + "valueShape": { + "type": "id", + "id": "type_:SchemasImageInfoColorMode" + }, + "description": "Image color mode." + }, + { + "key": "orientation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Image orientation from EXIF." + }, + { + "key": "format", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Image format." + }, + { + "key": "sequence", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Set to true if a file contains a sequence of images (GIF for example)." + }, + { + "key": "height", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Image height in pixels." + }, + { + "key": "width", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Image width in pixels." + }, + { + "key": "geo_location", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SchemasImageInfoGeoLocation" + } + }, + "description": "Geo-location of image from EXIF." + }, + { + "key": "datetime_original", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Image date and time from EXIF. Please be aware that this data is not always formatted and displayed exactly as it appears in the EXIF." + }, + { + "key": "dpi", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + "description": "Image DPI for two dimensions." + } + ] + } + }, + "type_:VideoInfoAudioItem": { + "name": "VideoInfoAudioItem", + "description": "Audio stream's metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Audio stream's bitrate." + }, + { + "key": "codec", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Audio stream's codec." + }, + { + "key": "sample_rate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Audio stream's sample rate." + }, + { + "key": "channels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Audio stream's number of channels." + } + ] + } + }, + "type_:VideoInfoVideoItem": { + "name": "VideoInfoVideoItem", + "description": "Video stream's metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "height", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Video stream's image height." + }, + { + "key": "width", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Video stream's image width." + }, + { + "key": "frame_rate", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Video stream's frame rate." + }, + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Video stream's bitrate." + }, + { + "key": "codec", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Video stream's codec." + } + ] + } + }, + "type_:VideoInfo": { + "name": "VideoInfo", + "description": "Video metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "duration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Video file's duration in milliseconds." + }, + { + "key": "format", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Video file's format." + }, + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Video file's bitrate." + }, + { + "key": "audio", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VideoInfoAudioItem" + } + } + }, + { + "key": "video", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VideoInfoVideoItem" + } + } + } + ] + } + }, + "type_:ContentInfoMime": { + "name": "ContentInfoMime", + "description": "MIME type.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mime", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Full MIME type." + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Type of MIME type." + }, + { + "key": "subtype", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Subtype of MIME type." + } + ] + } + }, + "type_:ContentInfo": { + "name": "ContentInfo", + "description": "Information about file content.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mime", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ContentInfoMime" + } + }, + "description": "MIME type." + }, + { + "key": "image", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:SchemasImageInfo" + } + } + }, + { + "key": "video", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VideoInfo" + } + } + } + ] + } + }, + "type_:Metadata": { + "name": "Metadata", + "description": "Arbitrary metadata associated with a file.", + "shape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + } + }, + "subpackages": { + "subpackage_upload": { + "id": "subpackage_upload", + "name": "Upload" + }, + "subpackage_groups": { + "id": "subpackage_groups", + "name": "Groups" + } + }, + "auths": {} + }, + { + "id": "fb019a78-a773-4315-9c7b-6dcb585d6b30", + "endpoints": { + "__package__.File metadata": { + "id": "__package__.File metadata", + "namespace": [], + "description": "Get file's metadata keys and values.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/files/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/metadata" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "21975c81-7f57-4c7a-aef9-acfe28779f78" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "string": { + "key": "value" + } + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n getMetadata,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await getMetadata(\n {\n uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$fileInfo = $api->fileInfo('1bac376c-aa7e-4356-861b-dd2657b5bfd2');\necho \\sprintf(\"File %s metadata:\\n\", $fileInfo->getUuid());\nforeach ($fileInfo->getMetadata() as $metaKey => $metaItem) {\n echo \\sprintf(\"%s: %s\\n\", $metaKey, $metaItem);\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nvalue = uploadcare.metadata_api.get_all_metadata(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(value)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\nputs Uploadcare::FileMetadata.show(uuid, 'pet')\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet metadata = try await uploadcare.fileMetadata(withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(metadata)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval metadata = uploadcare.getFileMetadata(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nLog.d(\"TAG\", metadata.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/files/:uuid/metadata \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/files/:uuid/metadata \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.filesList": { + "id": "subpackage_file.filesList", + "namespace": [ + "subpackage_file" + ], + "description": "Getting a paginated list of files. If you need multiple results pages, use `previous`/`next` from the response to navigate back/forth.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/files" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "removed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`true` to only include removed files in the response, `false` to include existing files. Defaults to `false`." + }, + { + "key": "stored", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "`true` to only include files that were stored, `false` to include temporary ones. The default is unset: both stored and not stored files are returned." + }, + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "A preferred amount of files in a list for a single response. Defaults to 100, while the maximum is 1000." + }, + { + "key": "ordering", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_file:FilesListRequestOrdering" + } + }, + "description": "Specifies the way files are sorted in a returned list. `datetime_uploaded` for ascending order, `-datetime_uploaded` for descending order." + }, + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A starting point for filtering the files. If provided, the value MUST adhere to the ISO 8601 Extended Date/Time Format (`YYYY-MM-DDTHH:MM:SSZ`)." + }, + { + "key": "include", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Include additional fields to the file object, such as: appdata." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_file:FilesListResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "removed": true, + "stored": true, + "limit": 100, + "from": "2015-09-10T10:00:00Z" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "next": "https://api.uploadcare.com/files/?from=2018-11-27T01%3A00%3A24.296613%2B00%3A00&limit=3&offset=0", + "previous": "https://api.uploadcare.com/files/?limit=3&to=2018-11-27T01%3A00%3A36.436838%2B00%3A00&offset=0", + "total": 26, + "totals": { + "removed": 0, + "stored": 25, + "unstored": 1 + }, + "per_page": 100, + "results": [ + { + "datetime_uploaded": "2018-11-26T12:49:09Z", + "is_image": true, + "is_ready": true, + "mime_type": "image/jpeg", + "original_filename": "pineapple.jpg", + "size": 642, + "url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/", + "uuid": "22240276-2f06-41f8-9411-755c8ce926ed", + "datetime_removed": "2024-01-15T09:30:00Z", + "datetime_stored": "2018-11-26T12:49:10Z", + "original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg", + "appdata": { + "aws_rekognition_detect_labels": { + "datetime_created": "2021-09-21T11:25:31Z", + "datetime_updated": "2021-09-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "LabelModelVersion": "2.0", + "Labels": [ + { + "Confidence": 93.41645812988281, + "Instances": [ + {} + ], + "Name": "Home Decor", + "Parents": [ + {} + ] + }, + { + "Confidence": 70.75951385498047, + "Instances": [ + {} + ], + "Name": "Linen", + "Parents": [ + { + "Name": "Home Decor" + } + ] + }, + { + "Confidence": 64.7123794555664, + "Instances": [ + {} + ], + "Name": "Sunlight", + "Parents": [ + {} + ] + }, + { + "Confidence": 56.264793395996094, + "Instances": [ + {} + ], + "Name": "Flare", + "Parents": [ + { + "Name": "Light" + } + ] + }, + { + "Confidence": 50.47153854370117, + "Instances": [ + {} + ], + "Name": "Tree", + "Parents": [ + { + "Name": "Plant" + } + ] + } + ] + } + }, + "aws_rekognition_detect_moderation_labels": { + "datetime_created": "2023-02-21T11:25:31Z", + "datetime_updated": "2023-02-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "ModerationModelVersion": "6.0", + "ModerationLabels": [ + { + "Confidence": 93.41645812988281, + "Name": "Weapons", + "ParentName": "Violence" + } + ] + } + }, + "remove_bg": { + "datetime_created": "2021-07-25T12:24:33Z", + "datetime_updated": "2021-07-25T12:24:33Z", + "version": "1.0", + "data": { + "foreground_type": "person" + } + }, + "uc_clamav_virus_scan": { + "datetime_created": "2021-09-21T11:24:33Z", + "datetime_updated": "2021-09-21T11:24:33Z", + "version": "0.104.2", + "data": { + "infected": true, + "infected_with": "Win.Test.EICAR_HDB-1" + } + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 500, + "width": 500, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + } + } + ] + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n listOfFiles,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await listOfFiles(\n {},\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$list = $api->listFiles();\nforeach ($list->getResults() as $result) {\n echo \\sprintf('URL: %s', $result->getUrl());\n}\nwhile (($next = $api->nextPage($list)) !== null) {\n foreach ($next->getResults() as $result) {\n echo \\sprintf('URL: %s', $result->getUrl());\n }\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfiles = uploadcare.list_files(stored=True, limit=10)\nfor file in files:\n print(file.info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nlist = Uploadcare::FileList.file_list(stored: true, removed: false, limit: 100)\nlist.each { |file| puts file.inspect }\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet query = PaginationQuery()\n .stored(true)\n .ordering(.dateTimeUploadedDESC)\n .limit(10)\nvar list = uploadcare.listOfFiles()\n\ntry await list.get(withQuery: query)\nprint(list)\n\n// Next page\nif list.next != nil {\n try await list.nextPage()\n print(list)\n}\n\n// Previous page\nif list.previous != nil {\n try await filesList.previousPage()\n print(list)\n}\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval filesQueryBuilder = uploadcare.getFiles()\nval files = filesQueryBuilder\n .stored(true)\n .ordering(Order.UPLOAD_TIME_DESC)\n .asList()\nLog.d(\"TAG\", files.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files \\\n -H \"Authorization: \" \\\n -d removed=true \\\n -d stored=true \\\n -d limit=100 \\\n --data-urlencode from=2015-09-10T10:00:00Z", + "generated": true + } + ] + } + }, + { + "path": "/files", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "removed": true, + "stored": true + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d removed=true \\\n -d stored=true", + "generated": true + } + ] + } + }, + { + "path": "/files", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "removed": true, + "stored": true + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d removed=true \\\n -d stored=true", + "generated": true + } + ] + } + }, + { + "path": "/files", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": { + "removed": true, + "stored": true + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d removed=true \\\n -d stored=true", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.storeFile": { + "id": "subpackage_file.storeFile", + "namespace": [ + "subpackage_file" + ], + "description": "Store a single file by UUID. When file is stored, it is available permanently. If not stored — it will only be available for 24 hours. If the parameter is omitted, it checks the `Auto file storing` setting of your Uploadcare project identified by the `public_key` provided in the `auth-param`.", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/files/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/storage" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:File" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/21975c81-7f57-4c7a-aef9-acfe28779f78/storage", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "21975c81-7f57-4c7a-aef9-acfe28779f78" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "datetime_uploaded": "2018-11-26T12:49:09Z", + "is_image": true, + "is_ready": true, + "mime_type": "image/jpeg", + "original_filename": "pineapple.jpg", + "size": 642, + "url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/", + "uuid": "22240276-2f06-41f8-9411-755c8ce926ed", + "datetime_removed": "2024-01-15T09:30:00Z", + "datetime_stored": "2018-11-26T12:49:10Z", + "original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg", + "appdata": { + "aws_rekognition_detect_labels": { + "datetime_created": "2021-09-21T11:25:31Z", + "datetime_updated": "2021-09-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "LabelModelVersion": "2.0", + "Labels": [ + { + "Confidence": 93.41645812988281, + "Instances": [ + {} + ], + "Name": "Home Decor", + "Parents": [ + {} + ] + }, + { + "Confidence": 70.75951385498047, + "Instances": [ + {} + ], + "Name": "Linen", + "Parents": [ + { + "Name": "Home Decor" + } + ] + }, + { + "Confidence": 64.7123794555664, + "Instances": [ + {} + ], + "Name": "Sunlight", + "Parents": [ + {} + ] + }, + { + "Confidence": 56.264793395996094, + "Instances": [ + {} + ], + "Name": "Flare", + "Parents": [ + { + "Name": "Light" + } + ] + }, + { + "Confidence": 50.47153854370117, + "Instances": [ + {} + ], + "Name": "Tree", + "Parents": [ + { + "Name": "Plant" + } + ] + } + ] + } + }, + "aws_rekognition_detect_moderation_labels": { + "datetime_created": "2023-02-21T11:25:31Z", + "datetime_updated": "2023-02-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "ModerationModelVersion": "6.0", + "ModerationLabels": [ + { + "Confidence": 93.41645812988281, + "Name": "Weapons", + "ParentName": "Violence" + } + ] + } + }, + "remove_bg": { + "datetime_created": "2021-07-25T12:24:33Z", + "datetime_updated": "2021-07-25T12:24:33Z", + "version": "1.0", + "data": { + "foreground_type": "person" + } + }, + "uc_clamav_virus_scan": { + "datetime_created": "2021-09-21T11:24:33Z", + "datetime_updated": "2021-09-21T11:24:33Z", + "version": "0.104.2", + "data": { + "infected": true, + "infected_with": "Win.Test.EICAR_HDB-1" + } + } + }, + "variations": { + "variations": { + "key": "value" + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 500, + "width": 500, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + } + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n storeFile,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await storeFile(\n {\n uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$result = $api->storeFile('1bac376c-aa7e-4356-861b-dd2657b5bfd2');\necho \\sprintf('File %s is stored at %s', $result->getUuid(), $result->getDatetimeStored()->format(\\DateTimeInterface::ATOM));\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nfile.store()\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\nUploadcare::File.store(uuid)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet file = try await uploadcare.storeFile(withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nuploadcare.saveFile(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/storage \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 429, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.deleteFileStorage": { + "id": "subpackage_file.deleteFileStorage", + "namespace": [ + "subpackage_file" + ], + "description": "Removes individual files. Returns file info.\n\nNote: this operation removes the file from storage but doesn't invalidate CDN cache.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/files/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/storage" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:File" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/21975c81-7f57-4c7a-aef9-acfe28779f78/storage", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "21975c81-7f57-4c7a-aef9-acfe28779f78" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "datetime_uploaded": "2024-01-15T09:30:00Z", + "is_image": true, + "is_ready": true, + "mime_type": "image/jpeg", + "original_filename": "EU_4.jpg", + "size": 145212, + "url": "https://api.uploadcare.com/files/e10ce759-42c3-4185-bae5-e22a9143d68f/", + "uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46", + "datetime_removed": "2024-01-15T09:30:00Z", + "datetime_stored": "2024-01-15T09:30:00Z", + "original_file_url": "https://ucarecdn.com/e575ed4e8-f4e8-4c14-a58b-1527b6d9ee46/EU_4.jpg", + "appdata": { + "aws_rekognition_detect_labels": { + "datetime_created": "2024-01-15T09:30:00Z", + "datetime_updated": "2024-01-15T09:30:00Z", + "version": "2016-06-27", + "data": { + "LabelModelVersion": "LabelModelVersion", + "Labels": [ + { + "Confidence": 1.1, + "Instances": [ + {} + ], + "Name": "Name", + "Parents": [ + {} + ] + } + ] + } + }, + "aws_rekognition_detect_moderation_labels": { + "datetime_created": "2024-01-15T09:30:00Z", + "datetime_updated": "2024-01-15T09:30:00Z", + "version": "2016-06-27", + "data": { + "ModerationModelVersion": "ModerationModelVersion", + "ModerationLabels": [ + { + "Confidence": 1.1, + "Name": "Name", + "ParentName": "ParentName" + } + ] + } + }, + "uc_clamav_virus_scan": { + "datetime_created": "2024-01-15T09:30:00Z", + "datetime_updated": "2024-01-15T09:30:00Z", + "version": "0.104.2", + "data": { + "infected": true + } + } + }, + "variations": { + "variations": { + "key": "value" + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 2352, + "width": 2935, + "orientation": 6, + "geo_location": { + "latitude": -1.1884555555555556, + "longitude": 52.66996666666667 + }, + "datetime_original": "2018-09-13T20:23:40Z", + "dpi": [ + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "metadata": { + "key": "value" + } + } + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n deleteFile,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await deleteFile(\n {\n uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file()->deleteFile('1bac376c-aa7e-4356-861b-dd2657b5bfd2');\necho \\sprintf('File \\'%s\\' deleted at \\'%s\\'', $fileInfo->getUuid(), $fileInfo->getDatetimeRemoved()->format(\\DateTimeInterface::ATOM));\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nfile.delete()\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nputs Uploadcare::File.delete('1bac376c-aa7e-4356-861b-dd2657b5bfd2')\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet file = try await uploadcare.deleteFile(withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nuploadcare.deleteFile(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/storage \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/storage", + "responseStatusCode": 429, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/:uuid/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.info": { + "id": "subpackage_file.info", + "namespace": [ + "subpackage_file" + ], + "description": "Get file information by its UUID (immutable).", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/files/" + }, + { + "type": "pathParameter", + "value": "uuid" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + } + ], + "queryParameters": [ + { + "key": "include", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Include additional fields to the file object, such as: appdata." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:File" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/03ccf9ab-f266-43fb-973d-a6529c55c2ae", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "03ccf9ab-f266-43fb-973d-a6529c55c2ae" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "datetime_uploaded": "2024-01-15T09:30:00Z", + "is_image": true, + "is_ready": true, + "mime_type": "image/jpeg", + "original_filename": "EU_4.jpg", + "size": 145212, + "url": "https://api.uploadcare.com/files/e10ce759-42c3-4185-bae5-e22a9143d68f/", + "uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46", + "datetime_removed": "2024-01-15T09:30:00Z", + "datetime_stored": "2024-01-15T09:30:00Z", + "original_file_url": "https://ucarecdn.com/e575ed4e8-f4e8-4c14-a58b-1527b6d9ee46/EU_4.jpg", + "appdata": { + "aws_rekognition_detect_labels": { + "datetime_created": "2024-01-15T09:30:00Z", + "datetime_updated": "2024-01-15T09:30:00Z", + "version": "2016-06-27", + "data": { + "LabelModelVersion": "LabelModelVersion", + "Labels": [ + { + "Confidence": 1.1, + "Instances": [ + {} + ], + "Name": "Name", + "Parents": [ + {} + ] + } + ] + } + }, + "aws_rekognition_detect_moderation_labels": { + "datetime_created": "2024-01-15T09:30:00Z", + "datetime_updated": "2024-01-15T09:30:00Z", + "version": "2016-06-27", + "data": { + "ModerationModelVersion": "ModerationModelVersion", + "ModerationLabels": [ + { + "Confidence": 1.1, + "Name": "Name", + "ParentName": "ParentName" + } + ] + } + }, + "uc_clamav_virus_scan": { + "datetime_created": "2024-01-15T09:30:00Z", + "datetime_updated": "2024-01-15T09:30:00Z", + "version": "0.104.2", + "data": { + "infected": true + } + } + }, + "variations": { + "variations": { + "key": "value" + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 2352, + "width": 2935, + "orientation": 6, + "geo_location": { + "latitude": -1.1884555555555556, + "longitude": 52.66996666666667 + }, + "datetime_original": "2018-09-13T20:23:40Z", + "dpi": [ + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "metadata": { + "key": "value" + } + } + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n fileInfo,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await fileInfo(\n {\n uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$fileInfo = $api->fileInfo('1bac376c-aa7e-4356-861b-dd2657b5bfd2');\necho \\sprintf('URL: %s, ID: %s, Mime type: %s', $fileInfo->getUrl(), $fileInfo->getUuid(), $fileInfo->getMimeType());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(file.info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\nputs Uploadcare::File.info(uuid).inspect\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet fileInfoQuery = FileInfoQuery().include(.appdata)\nlet file = try await uploadcare.fileInfo(withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", withQuery: fileInfoQuery)\nprint(file)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval file = uploadcare.getFile(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nLog.d(\"TAG\", file.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/files/03ccf9ab-f266-43fb-973d-a6529c55c2ae \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": { + "include": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d include=string", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": { + "include": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d include=string", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": { + "include": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d include=string", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid", + "responseStatusCode": 429, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": { + "include": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/files/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d include=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.filesStoring": { + "id": "subpackage_file.filesStoring", + "namespace": [ + "subpackage_file" + ], + "description": "Used to store multiple files in one go. Up to 100 files are supported per request. A JSON object holding your File list SHOULD be put into a request body.", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/files/storage" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_file:FilesStoringResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/storage", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": { + "status": "ok", + "problems": { + "problems": { + "key": "value" + } + }, + "result": [ + { + "datetime_uploaded": "2018-11-26T12:49:09Z", + "is_image": true, + "is_ready": true, + "mime_type": "image/jpeg", + "original_filename": "pineapple.jpg", + "size": 642, + "url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/", + "uuid": "22240276-2f06-41f8-9411-755c8ce926ed", + "datetime_removed": "2024-01-15T09:30:00Z", + "datetime_stored": "2018-11-26T12:49:10Z", + "original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg", + "appdata": { + "aws_rekognition_detect_labels": { + "datetime_created": "2021-09-21T11:25:31Z", + "datetime_updated": "2021-09-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "LabelModelVersion": "2.0", + "Labels": [ + { + "Confidence": 93.41645812988281, + "Instances": [ + {} + ], + "Name": "Home Decor", + "Parents": [ + {} + ] + }, + { + "Confidence": 70.75951385498047, + "Instances": [ + {} + ], + "Name": "Linen", + "Parents": [ + { + "Name": "Home Decor" + } + ] + }, + { + "Confidence": 64.7123794555664, + "Instances": [ + {} + ], + "Name": "Sunlight", + "Parents": [ + {} + ] + }, + { + "Confidence": 56.264793395996094, + "Instances": [ + {} + ], + "Name": "Flare", + "Parents": [ + { + "Name": "Light" + } + ] + }, + { + "Confidence": 50.47153854370117, + "Instances": [ + {} + ], + "Name": "Tree", + "Parents": [ + { + "Name": "Plant" + } + ] + } + ] + } + }, + "aws_rekognition_detect_moderation_labels": { + "datetime_created": "2023-02-21T11:25:31Z", + "datetime_updated": "2023-02-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "ModerationModelVersion": "6.0", + "ModerationLabels": [ + { + "Confidence": 93.41645812988281, + "Name": "Weapons", + "ParentName": "Violence" + } + ] + } + }, + "remove_bg": { + "datetime_created": "2021-07-25T12:24:33Z", + "datetime_updated": "2021-07-25T12:24:33Z", + "version": "1.0", + "data": { + "foreground_type": "person" + } + }, + "uc_clamav_virus_scan": { + "datetime_created": "2021-09-21T11:24:33Z", + "datetime_updated": "2021-09-21T11:24:33Z", + "version": "0.104.2", + "data": { + "infected": true, + "infected_with": "Win.Test.EICAR_HDB-1" + } + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 500, + "width": 500, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + } + } + ] + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n storeFiles,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await storeFiles(\n {\n uuids: [\n 'b7a301d1-1bd0-473d-8d32-708dd55addc0',\n '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n ]\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$result = $api->batchStoreFile(['b7a301d1-1bd0-473d-8d32-708dd55addc0', '1bac376c-aa7e-4356-861b-dd2657b5bfd2']);\nforeach ($result->getResult() as $result) {\n if (!$result instanceof FileInfoInterface) {\n continue;\n }\n \\sprintf('Result %s is stored at %s', $result->getUuid(), $result->getDatetimeStored()->format(\\DateTimeInterface::ATOM));\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfiles = [\n 'b7a301d1-1bd0-473d-8d32-708dd55addc0',\n '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\n]\nuploadcare.store_files(files)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuids = [\n 'b7a301d1-1bd0-473d-8d32-708dd55addc0',\n '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\n]\nUploadcare::FileList.batch_store(uuids)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet uuids = [\n \"b7a301d1-1bd0-473d-8d32-708dd55addc0\",\n \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\n]\nlet response = try await uploadcare.storeFiles(withUUIDs: uuids)\nprint(response)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval uuids = listOf(\n \"b7a301d1-1bd0-473d-8d32-708dd55addc0\",\n \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\n)\nuploadcare.saveFiles(uuids)\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/storage \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + }, + { + "path": "/files/storage", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + }, + { + "path": "/files/storage", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + }, + { + "path": "/files/storage", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.filesDelete": { + "id": "subpackage_file.filesDelete", + "namespace": [ + "subpackage_file" + ], + "description": "Used to delete multiple files in one go. Up to 100 files are supported per request. A JSON object holding your File list SHOULD be put into a request body.\n\nNote: this operation removes files from storage but doesn't invalidate CDN cache.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/files/storage" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_file:FilesDeleteResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/storage", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": { + "status": "ok", + "problems": { + "problems": { + "key": "value" + } + }, + "result": [ + { + "datetime_uploaded": "2018-11-26T12:49:09Z", + "is_image": true, + "is_ready": true, + "mime_type": "image/jpeg", + "original_filename": "pineapple.jpg", + "size": 642, + "url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/", + "uuid": "22240276-2f06-41f8-9411-755c8ce926ed", + "datetime_removed": "2024-01-15T09:30:00Z", + "datetime_stored": "2018-11-26T12:49:10Z", + "original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg", + "appdata": { + "aws_rekognition_detect_labels": { + "datetime_created": "2021-09-21T11:25:31Z", + "datetime_updated": "2021-09-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "LabelModelVersion": "2.0", + "Labels": [ + { + "Confidence": 93.41645812988281, + "Instances": [ + {} + ], + "Name": "Home Decor", + "Parents": [ + {} + ] + }, + { + "Confidence": 70.75951385498047, + "Instances": [ + {} + ], + "Name": "Linen", + "Parents": [ + { + "Name": "Home Decor" + } + ] + }, + { + "Confidence": 64.7123794555664, + "Instances": [ + {} + ], + "Name": "Sunlight", + "Parents": [ + {} + ] + }, + { + "Confidence": 56.264793395996094, + "Instances": [ + {} + ], + "Name": "Flare", + "Parents": [ + { + "Name": "Light" + } + ] + }, + { + "Confidence": 50.47153854370117, + "Instances": [ + {} + ], + "Name": "Tree", + "Parents": [ + { + "Name": "Plant" + } + ] + } + ] + } + }, + "aws_rekognition_detect_moderation_labels": { + "datetime_created": "2023-02-21T11:25:31Z", + "datetime_updated": "2023-02-21T11:27:33Z", + "version": "2016-06-27", + "data": { + "ModerationModelVersion": "6.0", + "ModerationLabels": [ + { + "Confidence": 93.41645812988281, + "Name": "Weapons", + "ParentName": "Violence" + } + ] + } + }, + "remove_bg": { + "datetime_created": "2021-07-25T12:24:33Z", + "datetime_updated": "2021-07-25T12:24:33Z", + "version": "1.0", + "data": { + "foreground_type": "person" + } + }, + "uc_clamav_virus_scan": { + "datetime_created": "2021-09-21T11:24:33Z", + "datetime_updated": "2021-09-21T11:24:33Z", + "version": "0.104.2", + "data": { + "infected": true, + "infected_with": "Win.Test.EICAR_HDB-1" + } + } + }, + "content_info": { + "mime": { + "mime": "image/jpeg", + "type": "image", + "subtype": "jpeg" + }, + "image": { + "color_mode": "RGB", + "format": "JPEG", + "sequence": false, + "height": 500, + "width": 500, + "orientation": 6, + "geo_location": { + "latitude": 55.62013611111111, + "longitude": 37.66299166666666 + }, + "datetime_original": "2018-08-20T12:59:50Z", + "dpi": [ + 72, + 72 + ] + }, + "video": { + "format": "mp4", + "audio": [ + { + "bitrate": 78, + "codec": "aac", + "sample_rate": 44100, + "channels": 2 + } + ], + "video": [ + { + "height": 360, + "width": 640, + "frame_rate": 30, + "bitrate": 315, + "codec": "h264" + } + ], + "duration": 261827, + "bitrate": 393 + } + }, + "metadata": { + "subsystem": "uploader", + "pet": "cat" + } + } + ] + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n deleteFiles,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await deleteFiles(\n {\n uuids: [\n '21975c81-7f57-4c7a-aef9-acfe28779f78',\n 'cbaf2d73-5169-4b2b-a543-496cf2813dff',\n ]\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$fileInfo = $api->fileInfo('21975c81-7f57-4c7a-aef9-acfe28779f78');\n$api->deleteFile($fileInfo);\necho \\sprintf('File \\'%s\\' deleted at \\'%s\\'', $fileInfo->getUuid(), $fileInfo->getDatetimeRemoved()->format(\\DateTimeInterface::ATOM));\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfiles = [\n '21975c81-7f57-4c7a-aef9-acfe28779f78',\n 'cbaf2d73-5169-4b2b-a543-496cf2813dff'\n ]\nuploadcare.delete_files(files)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuids = [\"21975c81-7f57-4c7a-aef9-acfe28779f78\", \"cbaf2d73-5169-4b2b-a543-496cf2813dff\"]\nputs Uploadcare::FileList.batch_delete(uuids)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet uuids = [\"21975c81-7f57-4c7a-aef9-acfe28779f78\", \"cbaf2d73-5169-4b2b-a543-496cf2813dff\"]\ntry await uploadcare.deleteFiles(withUUIDs: uuids)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval uuids = listOf(\"21975c81-7f57-4c7a-aef9-acfe28779f78\", \"cbaf2d73-5169-4b2b-a543-496cf2813dff\")\nuploadcare.deleteFiles(fileIds = uuids)\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/storage \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + }, + { + "path": "/files/storage", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + }, + { + "path": "/files/storage", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + }, + { + "path": "/files/storage", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": [ + "string" + ] + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/storage \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '[\n \"string\"\n]'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.createLocalCopy": { + "id": "subpackage_file.createLocalCopy", + "namespace": [ + "subpackage_file" + ], + "description": "POST requests are used to copy original files or their modified versions to a default storage.\n\nSource files MAY either be stored or just uploaded and MUST NOT be deleted.\n\nCopying of large files is not supported at the moment. If the file CDN URL includes transformation operators, its size MUST NOT exceed 100 MB. If not, the size MUST NOT exceed 5 GB.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/files/local_copy" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A CDN URL or just UUID of a file subjected to copy." + }, + { + "key": "store", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_file:CreateLocalCopyRequestStore" + } + }, + "description": "The parameter only applies to the Uploadcare storage and MUST be either true or false." + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Arbitrary additional metadata." + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:LocalCopyResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/local_copy", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "source": "03ccf9ab-f266-43fb-973d-a6529c55c2ae", + "store": "true", + "metadata": { + "subsystem": "uploader", + "pet": "cat" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "file", + "result": { + "datetime_uploaded": "2024-01-15T09:30:00Z", + "is_image": true, + "is_ready": true, + "mime_type": "image/jpeg", + "original_filename": "EU_4.jpg", + "size": 0, + "url": "url", + "uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46", + "variations": "variations", + "content_info": "content_info", + "datetime_removed": "2024-01-15T09:30:00Z", + "datetime_stored": "2024-01-15T09:30:00Z", + "original_file_url": "original_file_url", + "metadata": { + "metadata": { + "key": "value" + } + } + } + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n copyFileToLocalStorage,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await copyFileToLocalStorage(\n {\n source: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n store: true,\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$fileInfo = $api->copyToLocalStorage('03ccf9ab-f266-43fb-973d-a6529c55c2ae', true);\necho \\sprintf('File \\'%s\\' copied to local storage', $fileInfo->getUuid());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\ncopied_file = file.create_local_copy(store=True)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nsource = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\ncopied_file = Uploadcare::File.local_copy(source, store: true)\nputs copied_file.uuid\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet response = try await uploadcare.copyFileToLocalStorage(source: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(response)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval copyFile = uploadcare.copyFileLocalStorage(source = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nLog.d(\"TAG\", copyFile.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/local_copy \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"03ccf9ab-f266-43fb-973d-a6529c55c2ae\",\n \"store\": \"true\",\n \"metadata\": {\n \"subsystem\": \"uploader\",\n \"pet\": \"cat\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/files/local_copy", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "source": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/local_copy \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/files/local_copy", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "source": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/local_copy \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/files/local_copy", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "source": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/local_copy \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_file.createRemoteCopy": { + "id": "subpackage_file.createRemoteCopy", + "namespace": [ + "subpackage_file" + ], + "description": "POST requests are used to copy original files or their modified versions to a custom storage.\n\nSource files MAY either be stored or just uploaded and MUST NOT be deleted.\n\nCopying of large files is not supported at the moment. File size MUST NOT exceed 5 GB.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/files/remote_copy" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "A CDN URL or just UUID of a file subjected to copy." + }, + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Identifies a custom storage name related to your project. It implies that you are copying a file to a specified custom storage. Keep in mind that you can have multiple storages associated with a single S3 bucket." + }, + { + "key": "make_public", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "MUST be either `true` or `false`. The `true` value makes copied files available via public links, `false` does the opposite." + }, + { + "key": "pattern", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_file:CreateRemoteCopyRequestPattern" + } + }, + "description": "The parameter is used to specify file names Uploadcare passes to a custom storage. If the parameter is omitted, your custom storages pattern is used. Use any combination of allowed values.\n\nParameter values:\n- `${default}` = `${uuid}/${auto_filename}`\n- `${auto_filename}` = `${filename}${effects}${ext}`\n- `${effects}` = processing operations put into a CDN URL\n- `${filename}` = original filename without extension\n- `${uuid}` = file UUID\n- `${ext}` = file extension, including period, e.g. .jpg\n" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:CopiedFileUrl" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/remote_copy", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "source": "03ccf9ab-f266-43fb-973d-a6529c55c2ae", + "target": "mytarget", + "make_public": true + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "url", + "result": "s3://mybucket/03ccf9ab-f266-43fb-973d-a6529c55c2ae/image.png" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n copyFileToRemoteStorage,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await copyFileToRemoteStorage(\n {\n source: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n target: 'custom_storage_connected_to_the_project',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "file();\n$result = $api->copyToRemoteStorage('03ccf9ab-f266-43fb-973d-a6529c55c2ae', true);\necho \\sprintf('File \\'%s\\' copied to local storage', $result);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nr_copied_file = file.create_remote_copy(\n target='custom_storage_connected_to_the_project',\n make_public=True,\n pattern='${uuid}/${filename}${ext}',\n)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nsource = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\ntarget = 'custom_storage_connected_to_the_project'\ncopied_file = Uploadcare::File.remote_copy(source, target, make_public: true)\nputs copied_file.uuid\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet response = try await uploadcare.copyFileToRemoteStorage(source: \"03ccf9ab-f266-43fb-973d-a6529c55c2ae\", target: \"mytarget\", pattern: .uuid)\nprint(response)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval copyFile = uploadcare.copyFileRemoteStorage(\n source = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\",\n target = \"custom_storage_connected_to_the_project\"\n)\nLog.d(\"TAG\", copyFile.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/remote_copy \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"03ccf9ab-f266-43fb-973d-a6529c55c2ae\",\n \"target\": \"mytarget\",\n \"make_public\": true\n}'", + "generated": true + } + ] + } + }, + { + "path": "/files/remote_copy", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "source": "string", + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/remote_copy \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"string\",\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/files/remote_copy", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "source": "string", + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/remote_copy \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"string\",\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/files/remote_copy", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "source": "string", + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/files/remote_copy \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"string\",\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.awsRekognitionExecute": { + "id": "subpackage_addOns.awsRekognitionExecute", + "namespace": [ + "subpackage_addOns" + ], + "description": "Execute [AWS Rekognition](https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html) Add-On for a given target to detect labels in an image. **Note:** Detected labels are stored in the file's appdata.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/addons/aws_rekognition_detect_labels/execute" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID of the file to process" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:AwsRekognitionExecuteResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/aws_rekognition_detect_labels/execute", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "target": "21975c81-7f57-4c7a-aef9-acfe28779f78" + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "8db3c8b4-2dea-4146-bcdb-63387e2b33c1" + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$resultKey = $api->requestAwsRecognition('1bac376c-aa7e-4356-861b-dd2657b5bfd2');\necho \\sprintf('Recognition requested. Key is \\'%s\\'', $resultKey);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\ntarget_file = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\naws_recognition_result = uploadcare.addons_api.execute(\n target_file,\n AddonLabels.AWS_LABEL_RECOGNITION,\n)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\nUploadcare::Addons.ws_rekognition_detect_labels(uuid)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet response = try await uploadcare.executeAWSRekognition(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(response) // contains requestID\n\n// Execute and wait for completion:\nlet status = try await uploadcare.performAWSRekognition(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = AWSRekognitionAddOn(uploadcare)\nval response = addOn.execute(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nLog.d(\"TAG\", response.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"21975c81-7f57-4c7a-aef9-acfe28779f78\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_labels/execute", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_labels/execute", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_labels/execute", + "responseStatusCode": 409, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_labels/execute", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.awsRekognitionExecutionStatus": { + "id": "subpackage_addOns.awsRekognitionExecutionStatus", + "namespace": [ + "subpackage_addOns" + ], + "description": "Check the status of an Add-On execution request that had been started\nusing the [Execute Add-On](#operation/awsRekognitionExecute) operation.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/addons/aws_rekognition_detect_labels/execute/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "request_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Request ID returned by the Add-On execution request described above." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:AwsRekognitionExecutionStatusResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/aws_rekognition_detect_labels/execute/status", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "request_id": "request_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "in_progress" + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$status = $api->checkAwsRecognition('request-id');\necho \\sprintf('Recognition status: %s', $status);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\naddon_task_status = uploadcare.addons_api.status(request_id, AddonLabels.AWS_LABEL_RECOGNITION)\nprint(addon_task_status)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nrequest_id = \"d1fb31c6-ed34-4e21-bdc3-4f1485f58e21\"\nresult = Uploadcare::Addons.ws_rekognition_detect_labels_status(request_id)\nputs result.status\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet status = try await uploadcare.checkAWSRekognitionStatus(requestID: \"requestID\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = AWSRekognitionAddOn(uploadcare)\nval status = addOn.check(requestId = \"d1fb31c6-ed34-4e21-bdc3-4f1485f58e21\")\nLog.d(\"TAG\", status.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute/status \\\n -H \"Authorization: \" \\\n -d request_id=request_id", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_labels/execute/status", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_labels/execute/status", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/aws_rekognition_detect_labels/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.awsRekognitionDetectModerationLabelsExecute": { + "id": "subpackage_addOns.awsRekognitionDetectModerationLabelsExecute", + "namespace": [ + "subpackage_addOns" + ], + "description": "Execute [AWS Rekognition Moderation](https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html) Add-On for a given target to detect moderation labels in an image. **Note:** Detected moderation labels are stored in the file's appdata.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/addons/aws_rekognition_detect_moderation_labels/execute" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID of the file to process" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:AwsRekognitionDetectModerationLabelsExecuteResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "target": "21975c81-7f57-4c7a-aef9-acfe28779f78" + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "8db3c8b4-2dea-4146-bcdb-63387e2b33c1" + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$resultKey = $api->requestAwsRecognitionModeration('1bac376c-aa7e-4356-861b-dd2657b5bfd2');\necho \\sprintf('Recognition requested. Key is \\'%s\\'', $resultKey);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\ntarget_file = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\naws_recognition_result = uploadcare.addons_api.execute(\n target_file,\n AddonLabels.AWS_MODERATION_LABELS,\n)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet response = try await uploadcare.executeAWSRekognitionModeration(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(response) // contains requestID\n\n// Execute and wait for completion:\nlet status = try await uploadcare.performAWSRekognitionModeration(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = AWSRekognitionModerationAddOn(uploadcare)\nval response = addOn.execute(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nLog.d(\"TAG\", response.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"21975c81-7f57-4c7a-aef9-acfe28779f78\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute", + "responseStatusCode": 409, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus": { + "id": "subpackage_addOns.awsRekognitionDetectModerationLabelsExecutionStatus", + "namespace": [ + "subpackage_addOns" + ], + "description": "Check the status of an Add-On execution request that had been started\nusing the [Execute Add-On](#operation/awsRekognitionDetectModerationLabelsExecute) operation.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/addons/aws_rekognition_detect_moderation_labels/execute/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "request_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Request ID returned by the Add-On execution request described above." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute/status", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "request_id": "request_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "in_progress" + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$status = $api->checkAwsRecognitionModeration('request-id');\necho \\sprintf('Recognition status: %s', $status);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\naddon_task_status = uploadcare.addons_api.status(request_id, AddonLabels.AWS_MODERATION_LABEL)\nprint(addon_task_status)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet status = try await uploadcare.checkAWSRekognitionModerationStatus(requestID: \"requestID\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = AWSRekognitionModerationAddOn(uploadcare)\nval status = addOn.check(requestId = \"d1fb31c6-ed34-4e21-bdc3-4f1485f58e21\")\nLog.d(\"TAG\", status.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute/status \\\n -H \"Authorization: \" \\\n -d request_id=request_id", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute/status", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + }, + { + "path": "/addons/aws_rekognition_detect_moderation_labels/execute/status", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/aws_rekognition_detect_moderation_labels/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.ucClamavVirusScanExecute": { + "id": "subpackage_addOns.ucClamavVirusScanExecute", + "namespace": [ + "subpackage_addOns" + ], + "description": "Execute [ClamAV](https://www.clamav.net/) virus checking Add-On for a given target.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/addons/uc_clamav_virus_scan/execute" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID of the file to process" + }, + { + "key": "params", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:UcClamavVirusScanExecuteRequestParams" + } + }, + "description": "Optional object with Add-On specific parameters" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:UcClamavVirusScanExecuteResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/uc_clamav_virus_scan/execute", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "target": "21975c81-7f57-4c7a-aef9-acfe28779f78", + "params": { + "purge_infected": true + } + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "8db3c8b4-2dea-4146-bcdb-63387e2b33c1" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n executeAddon,\n AddonName,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await executeAddon(\n {\n addonName: AddonName.UC_CLAMAV_VIRUS_SCAN,\n target: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$resultKey = $api->requestAntivirusScan('21975c81-7f57-4c7a-aef9-acfe28779f78');\necho \\sprintf('Antivirus scan requested. Key is \\'%s\\'', $resultKey);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nclamav_params = AddonClamAVExecutionParams(purge_infected=True)\ntarget_file = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nclamav_result = uploadcare.addons_api.execute(\n target_file.uuid,\n AddonLabels.CLAM_AV,\n clamav_params\n)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\nUploadcare::Addons.uc_clamav_virus_scan(uuid, purge_infected: true)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet parameters = ClamAVAddonExecutionParams(purgeInfected: true)\nlet response = try await uploadcare.executeClamav(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", parameters: parameters)\nprint(response) // contains requestID\n\n// Execute and wait for completion:\nlet status = try await uploadcare.performClamav(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", parameters: parameters)\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = ClamAVAddOn(uploadcare)\nval response = addOn.execute(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nLog.d(\"TAG\", response.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"21975c81-7f57-4c7a-aef9-acfe28779f78\",\n \"params\": {\n \"purge_infected\": true\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/uc_clamav_virus_scan/execute", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/uc_clamav_virus_scan/execute", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/uc_clamav_virus_scan/execute", + "responseStatusCode": 409, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/uc_clamav_virus_scan/execute", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.ucClamavVirusScanExecutionStatus": { + "id": "subpackage_addOns.ucClamavVirusScanExecutionStatus", + "namespace": [ + "subpackage_addOns" + ], + "description": "Check the status of an Add-On execution request that had been started\nusing the [Execute Add-On](#operation/ucClamavVirusScanExecute) operation.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/addons/uc_clamav_virus_scan/execute/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "request_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Request ID returned by the Add-On execution request described above." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:UcClamavVirusScanExecutionStatusResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/uc_clamav_virus_scan/execute/status", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "request_id": "request_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "in_progress" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n addonExecutionStatus,\n AddonName,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await addonExecutionStatus(\n {\n addonName: AddonName.UC_CLAMAV_VIRUS_SCAN,\n requestId: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$status = $api->checkAntivirusScan('request-id');\necho \\sprintf('Antivirus scan status: %s', $status);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\naddon_task_status = uploadcare.addons_api.status(request_id, AddonLabels.CLAM_AV)\nprint(addon_task_status)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nrequest_id = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\nresult = Uploadcare::Addons.uc_clamav_virus_scan_status(request_id)\nputs result.status\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet status = try await uploadcare.checkClamAVStatus(requestID: \"requestID\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = ClamAVAddOn(uploadcare)\nval status = addOn.check(requestId = \"d1fb31c6-ed34-4e21-bdc3-4f1485f58e21\")\nLog.d(\"TAG\", status.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute/status \\\n -H \"Authorization: \" \\\n -d request_id=request_id", + "generated": true + } + ] + } + }, + { + "path": "/addons/uc_clamav_virus_scan/execute/status", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + }, + { + "path": "/addons/uc_clamav_virus_scan/execute/status", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.removeBgExecute": { + "id": "subpackage_addOns.removeBgExecute", + "namespace": [ + "subpackage_addOns" + ], + "description": "Execute [remove.bg](https://remove.bg/) background image removal Add-On for a given target.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/addons/remove_bg/execute" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "target", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Unique ID of the file to process" + }, + { + "key": "params", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:RemoveBgExecuteRequestParams" + } + }, + "description": "Optional object with Add-On specific parameters" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:RemoveBgExecuteResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 409, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/remove_bg/execute", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "target": "21975c81-7f57-4c7a-aef9-acfe28779f78", + "params": { + "crop": true, + "scale": "30%", + "type_level": "2", + "roi": "0% 0% 90% 90%" + } + } + }, + "responseBody": { + "type": "json", + "value": { + "request_id": "8db3c8b4-2dea-4146-bcdb-63387e2b33c1" + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$resultKey = $api->requestRemoveBackground('21975c81-7f57-4c7a-aef9-acfe28779f78');\necho \\sprintf('Remove background requested. Key is \\'%s\\'', $resultKey);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nremove_bg_params = AddonRemoveBGExecutionParams(\n crop=True,\n crop_margin=\"20px\",\n scale=\"15%\",\n position ='',\n roi = ''\n)\n\ntarget_file = uploadcare.file(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nremove_bg_result = uploadcare.addons_api.execute(\n target_file,\n AddonLabels.REMOVE_BG,\n remove_bg_params\n)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\nUploadcare::Addons.remove_bg(uuid, crop: true)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet parameters = RemoveBGAddonExecutionParams(crop: true, typeLevel: .two)\nlet response = try await uploadcare.executeRemoveBG(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", parameters: parameters)\nprint(response) // contains requestID\n\n// Execute and wait for completion:\nlet status = try await uploadcare.performRemoveBG(fileUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = RemoveBgAddOn(uploadcare)\nval response = addOn.execute(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nLog.d(\"TAG\", response.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/remove_bg/execute \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"21975c81-7f57-4c7a-aef9-acfe28779f78\",\n \"params\": {\n \"crop\": true,\n \"scale\": \"30%\",\n \"type_level\": \"2\",\n \"roi\": \"0% 0% 90% 90%\"\n }\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/remove_bg/execute", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/remove_bg/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/remove_bg/execute", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/remove_bg/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/remove_bg/execute", + "responseStatusCode": 409, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/remove_bg/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/addons/remove_bg/execute", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": { + "target": "string" + } + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/addons/remove_bg/execute \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"target\": \"string\"\n}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_addOns.removeBgExecutionStatus": { + "id": "subpackage_addOns.removeBgExecutionStatus", + "namespace": [ + "subpackage_addOns" + ], + "description": "Check the status of an Add-On execution request that had been started\nusing the [Execute Add-On](#operation/removeBgExecute) operation.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/addons/remove_bg/execute/status" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "request_id", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Request ID returned by the Add-On execution request described above." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_addOns:RemoveBgExecutionStatusResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/addons/remove_bg/execute/status", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "request_id": "request_id" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "result": { + "file_id": "21975c81-7f57-4c7a-aef9-acfe28779f78" + }, + "status": "done" + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "addons();\n$status = $api->checkRemoveBackground('request-id');\necho \\sprintf('Remove background status: %s', $status);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\naddon_task_status = uploadcare.addons_api.status(request_id, AddonLabels.REMOVE_BG)\nprint(addon_task_status)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nrequest_id = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\"\nresult = Uploadcare::Addons.remove_bg_status(request_id)\nputs result.status\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet status = try await uploadcare.checkRemoveBGStatus(requestID: \"requestID\")\nprint(status)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval addOn = RemoveBgAddOn(uploadcare)\nval status = addOn.check(requestId = \"d1fb31c6-ed34-4e21-bdc3-4f1485f58e21\")\nLog.d(\"TAG\", status.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/remove_bg/execute/status \\\n -H \"Authorization: \" \\\n -d request_id=request_id", + "generated": true + } + ] + } + }, + { + "path": "/addons/remove_bg/execute/status", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/remove_bg/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + }, + { + "path": "/addons/remove_bg/execute/status", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "request_id": "string" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/addons/remove_bg/execute/status \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d request_id=string", + "generated": true + } + ] + } + } + ] + }, + "subpackage_fileMetadata.key": { + "id": "subpackage_fileMetadata.key", + "namespace": [ + "subpackage_fileMetadata" + ], + "description": "Get the value of a single metadata key.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/files/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/metadata/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + }, + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of file metadata.\nList of allowed characters for the key:\n\n- Latin letters in lower or upper case (a-z,A-Z)\n- digits (0-9)\n- underscore `_`\n- a hyphen `-`\n- dot `.`\n- colon `:`" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MetadataItemValue" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "21975c81-7f57-4c7a-aef9-acfe28779f78", + "key": "subsystem" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": "uploader" + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n getMetadataValue,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await getMetadataValue(\n {\n uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n key: 'pet'\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "metadata();\n$metadata = $api->getMetadata('1bac376c-aa7e-4356-861b-dd2657b5bfd2');\necho \\sprintf('Value for key \\'pet\\' %s', $metadata['pet'] ?? 'does not exists');\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nvalue = uploadcare.metadata_api.get_key(\"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", \"pet\")\nprint(value)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\nputs Uploadcare::FileMetadata.index(uuid).inspect\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet value = try await uploadcare.fileMetadataValue(forKey: \"pet\", withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nprint(value)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval value = uploadcare.getFileMetadataKeyValue(\n fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\",\n key = \"pet\"\n)\nLog.d(\"TAG\", value)\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata/:key", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid", + "key": ":key" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/files/:uuid/metadata/:key \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata/:key", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid", + "key": ":key" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/files/:uuid/metadata/:key \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_fileMetadata.updateFileMetadataKey": { + "id": "subpackage_fileMetadata.updateFileMetadataKey", + "namespace": [ + "subpackage_fileMetadata" + ], + "description": "Update the value of a single metadata key. If the key does not exist, it will be created.", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/files/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/metadata/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + }, + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of file metadata.\nList of allowed characters for the key:\n\n- Latin letters in lower or upper case (a-z,A-Z)\n- digits (0-9)\n- underscore `_`\n- a hyphen `-`\n- dot `.`\n- colon `:`" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:MetadataItemValue" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "21975c81-7f57-4c7a-aef9-acfe28779f78", + "key": "subsystem" + }, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": "string" + }, + "responseBody": { + "type": "json", + "value": "uploader" + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n updateMetadata,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await updateMetadata(\n {\n uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n key: 'pet',\n value: 'dog',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "metadata();\n$result = $api->setKey('1bac376c-aa7e-4356-861b-dd2657b5bfd2', 'pet', 'dog');\necho \\sprintf('Metadata key \\'pet\\' is set to %s', $result['pet']);\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile_uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\nkey, value = \"pet\", \"dog\"\nuploadcare.metadata_api.update_or_create_key(file_uuid, key, value)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\nkey = 'pet'\nvalue = 'dog'\nUploadcare::FileMetadata.update(uuid, key, value)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet response = try await uploadcare.updateFileMetadata(\n withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", \n key: \"pet\", \n value: dog\n)\n print(response)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval value = uploadcare.updateFileMetadataKeyValue(\n fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\",\n key = \"pet\",\n value = \"dog\"\n)\nLog.d(\"TAG\", value)\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d \"string\"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata/:key", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid", + "key": ":key" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/:uuid/metadata/:key \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d \"string\"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata/:key", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid", + "key": ":key" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/files/:uuid/metadata/:key \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d \"string\"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_fileMetadata.deleteFileMetadataKey": { + "id": "subpackage_fileMetadata.deleteFileMetadataKey", + "namespace": [ + "subpackage_fileMetadata" + ], + "description": "Delete a file's metadata key.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/files/" + }, + { + "type": "pathParameter", + "value": "uuid" + }, + { + "type": "literal", + "value": "/metadata/" + }, + { + "type": "pathParameter", + "value": "key" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + }, + { + "key": "key", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Key of file metadata.\nList of allowed characters for the key:\n\n- Latin letters in lower or upper case (a-z,A-Z)\n- digits (0-9)\n- underscore `_`\n- a hyphen `-`\n- dot `.`\n- colon `:`" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem", + "responseStatusCode": 204, + "pathParameters": { + "uuid": "21975c81-7f57-4c7a-aef9-acfe28779f78", + "key": "subsystem" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n deleteMetadata,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await deleteMetadata(\n {\n uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',\n key: 'delete_key',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "metadata();\ntry {\n $metadataApi->removeKey('1bac376c-aa7e-4356-861b-dd2657b5bfd2', 'pet');\n} catch (\\Throwable $e) {\n echo \\sprintf('Error while key removing: %s', $e->getMessage());\n}\necho 'Key was successfully removed';\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile_uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'\nuploadcare.metadata_api.delete_key(file_uuid, mkey='pet')\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nputs Uploadcare::FileMetadata.delete('1bac376c-aa7e-4356-861b-dd2657b5bfd2', 'pet')\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\ntry await uploadcare.deleteFileMetadata(forKey: \"pet\", withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nuploadcare.deleteFileMetadataKey(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", key = \"pet\")\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata/:key", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid", + "key": ":key" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/:uuid/metadata/:key \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/files/:uuid/metadata/:key", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid", + "key": ":key" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/files/:uuid/metadata/:key \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_group.groupsList": { + "id": "subpackage_group.groupsList", + "namespace": [ + "subpackage_group" + ], + "description": "Get a paginated list of groups.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/groups" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "queryParameters": [ + { + "key": "limit", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "A preferred amount of groups in a list for a single response.\nDefaults to 100, while the maximum is 1000." + }, + { + "key": "from", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "A starting point for filtering the list of groups.\nIf passed, MUST be a date and time value in ISO-8601 format." + }, + { + "key": "ordering", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_group:GroupsListRequestOrdering" + } + }, + "description": "Specifies the way groups should be sorted in the returned list.\n`datetime_created` for the ascending order (default),\n`-datetime_created` for the descending one." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_group:GroupsListResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/groups", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": { + "limit": 150, + "from": "2015-01-02T10:00:00Z" + }, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "next": "https://api.uploadcare.com/groups/?limit=3&from=2018-11-27T01%3A00%3A24.296613%2B00%3A00&offset=0", + "previous": "https://api.uploadcare.com/groups/?limit=3&to=2018-11-27T01%3A00%3A36.436838%2B00%3A00&offset=0", + "total": 26, + "per_page": 100, + "results": [ + { + "id": "dd43982b-5447-44b2-86f6-1c3b52afa0ff~1", + "datetime_created": "2018-11-27T14:14:37Z", + "files_count": 1, + "cdn_url": "https://ucarecdn.com/dd43982b-5447-44b2-86f6-1c3b52afa0ff~1/", + "url": "https://api.uploadcare.com/groups/dd43982b-5447-44b2-86f6-1c3b52afa0ff~1/" + } + ] + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n listOfGroups,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await listOfGroups({}, { authSchema: uploadcareSimpleAuthSchema })\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "group();\n$list = $api->listGroups();\nforeach ($list->getResults() as $group) {\n \\sprintf('Group URL: %s, ID: %s', $group->getUrl(), $group->getUuid());\n}\nwhile (($next = $api->nextPage($list)) !== null) {\n foreach ($next->getResults() as $group) {\n \\sprintf('Group URL: %s, ID: %s', $group->getUrl(), $group->getUuid());\n }\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\ngroups_list = uploadcare.list_file_groups()\nprint('Number of groups is', groups_list.count())\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\ngroups = Uploadcare::GroupList.list(limit: 10)\ngroups.each { |group| puts group.inspect }\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet query = GroupsListQuery()\n .limit(10)\n .ordering(.datetimeCreatedDESC)\n \nlet groupsList = uploadcare.listOfGroups()\n\nlet list = try await groupsList.get(withQuery: query)\nprint(list)\n\n// Next page\nlet next = try await groupsList.nextPage()\nprint(list)\n\n// Previous page\nlet previous = try await groupsList.previousPage()\nprint(list)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval groupsQueryBuilder = uploadcare.getGroups()\nval groups = groupsQueryBuilder\n .ordering(Order.UPLOAD_TIME_DESC)\n .asList()\nLog.d(\"TAG\", groups.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/groups \\\n -H \"Authorization: \" \\\n -d limit=150 \\\n --data-urlencode from=2015-01-02T10:00:00Z", + "generated": true + } + ] + } + }, + { + "path": "/groups", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": { + "limit": 1, + "from": "2023-01-01T00:00:00Z" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/groups \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d limit=1 \\\n --data-urlencode from=2023-01-01T00:00:00Z", + "generated": true + } + ] + } + }, + { + "path": "/groups", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": { + "limit": 1, + "from": "2023-01-01T00:00:00Z" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/groups \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d limit=1 \\\n --data-urlencode from=2023-01-01T00:00:00Z", + "generated": true + } + ] + } + }, + { + "path": "/groups", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": { + "limit": 1, + "from": "2023-01-01T00:00:00Z" + }, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -G https://api.uploadcare.com/groups \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -d limit=1 \\\n --data-urlencode from=2023-01-01T00:00:00Z", + "generated": true + } + ] + } + } + ] + }, + "subpackage_group.info": { + "id": "subpackage_group.info", + "namespace": [ + "subpackage_group" + ], + "description": "Get a file group by its ID.\n\nGroups are identified in a way similar to individual files. A group ID consists of a UUID\nfollowed by a “~” (tilde) character and a group size: integer number of the files in the group.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/groups/" + }, + { + "type": "pathParameter", + "value": "uuid" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Group UUID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:GroupWithFiles" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/groups/badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "cdn_url": "cdn_url", + "datetime_created": "2024-01-15T09:30:00Z", + "files": [ + { + "key": "value" + } + ], + "files_count": 1, + "id": "id", + "url": "url" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n groupInfo,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await groupInfo(\n {\n uuid: 'c5bec8c7-d4b6-4921-9e55-6edb027546bc~1',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "group();\n$groupInfo = $api->groupInfo('c5bec8c7-d4b6-4921-9e55-6edb027546bc~1');\necho \\sprintf(\"Group: %s files:\\n\", $groupInfo->getUrl());\nforeach ($groupInfo->getFiles() as $file) {\n \\sprintf('File: %s (%s)', $file->getUrl(), $file->getUuid());\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\ngroup = uploadcare.file_group(\"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\")\nprint(group.info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nuuid = \"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\"\nputs Uploadcare::Group.info(uuid).inspect\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet group = try await uploadcare.groupInfo(withUUID: \"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\")\nprint(group)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval group = uploadcare.getGroup(groupId = \"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\")\nLog.d(\"TAG\", group.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/groups/badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12 \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 429, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_group.deleteGroup": { + "id": "subpackage_group.deleteGroup", + "namespace": [ + "subpackage_group" + ], + "description": "Delete a file group by its ID.\n\n**Note**: The operation only removes the group object itself. **All the files that were part of the group are left as is.**", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/groups/" + }, + { + "type": "pathParameter", + "value": "uuid" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Group UUID." + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/groups/badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12", + "responseStatusCode": 204, + "pathParameters": { + "uuid": "badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12" + }, + "queryParameters": {}, + "headers": {}, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n deleteGroup,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await deleteGroup(\n {\n uuid: 'c5bec8c7-d4b6-4921-9e55-6edb027546bc~1',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "group();\ntry {\n $api->removeGroup('c5bec8c7-d4b6-4921-9e55-6edb027546bc~1');\n} catch (\\Throwable $e) {\n echo \\sprintf('Error while group deletion: %s', $e->getMessage());\n}\necho 'Group successfully deleted';\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile_group = uploadcare.file_group(\"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\")\nfile_group.delete()\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nputs Uploadcare::Group.delete(\"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\")\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\ntry await uploadcare.deleteGroup(withUUID: \"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\")\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nuploadcare.deleteGroup(groupId = \"c5bec8c7-d4b6-4921-9e55-6edb027546bc~1\")\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/groups/badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12 \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/groups/:uuid", + "responseStatusCode": 429, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/groups/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_project.info": { + "id": "subpackage_project.info", + "namespace": [ + "subpackage_project" + ], + "description": "Getting info about account project.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/project" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Project" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/project", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "collaborators": [ + { + "email": "email", + "name": "name" + } + ], + "name": "demo", + "pub_key": "YOUR_PUBLIC_KEY", + "autostore_enabled": true + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "project();\n$projectInfo = $api->getProjectInfo();\necho \\sprintf(\"Project %s info:\\n\", $projectInfo->getName());\necho \\sprintf(\"Public key: %s\\n\", $projectInfo->getPubKey());\necho \\sprintf(\"Auto-store enabled: %s\\n\", $projectInfo->isAutostoreEnabled() ? 'yes' : 'no');\nforeach ($projectInfo->getCollaborators() as $email => $name) {\n echo \\sprintf(\"%s: %s\\n\", $name, $email);\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, ProjectInfo\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nproject_info = uploadcare.get_project_info()\nprint(project_info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nproject_info = Uploadcare::Project.show\nputs project_info.inspect\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet project = try await uploadcare.getProjectInfo()\nprint(project)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval project = uploadcare.getProject()\nLog.d(\"TAG\", project.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/project \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/project", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/project \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/project", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/project \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/project", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/project \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_webhook.webhooksList": { + "id": "subpackage_webhook.webhooksList", + "namespace": [ + "subpackage_webhook" + ], + "description": "List of project webhooks.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:WebhookOfListResponse" + } + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": [ + { + "id": 1, + "project": 13, + "created": "2016-04-27T11:49:54Z", + "updated": "2016-04-27T12:04:57Z", + "event": "file.infected", + "target_url": "http://example.com/hooks/receiver", + "is_active": true, + "version": "0.7", + "signing_secret": "7kMVZivndx0ErgvhRKAr" + } + ] + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n listOfWebhooks,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await listOfWebhooks({}, { authSchema: uploadcareSimpleAuthSchema })\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "webhook();\nforeach ($api->listWebhooks() as $webhook) {\n \\sprintf(\"Webhook with url %s is %s\\n\", $webhook->getTargetUrl(), $webhook->isActive() ? 'active' : 'not active');\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, Webhook\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nwebhooks: list[Webhook] = list(uploadcare.list_webhooks(limit=10))\nfor w in webhooks:\n print(w.id)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nwebhooks = Uploadcare::Webhook.list\nwebhooks.each { |webhook| puts webhook.inspect }\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet webhooks = try await uploadcare.getListOfWebhooks()\nfor webhook in webhooks {\n print(webhook)\n}\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval webhooks = uploadcare.getWebhooks()\nLog.d(\"TAG\", webhooks.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/webhooks \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/webhooks \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/webhooks \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/webhooks \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_webhook.create": { + "id": "subpackage_webhook.create", + "namespace": [ + "subpackage_webhook" + ], + "description": "Create and subscribe to a webhook. You can use webhooks to receive notifications about your uploads. For instance, once a file gets uploaded to your project, we can notify you by sending a message to a target URL.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/webhooks" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:WebhookOfListResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/webhooks", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": 1, + "project": 13, + "created": "2016-04-27T11:49:54Z", + "updated": "2016-04-27T12:04:57Z", + "event": "file.infected", + "target_url": "http://example.com/hooks/receiver", + "is_active": true, + "version": "0.7", + "signing_secret": "7kMVZivndx0ErgvhRKAr" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n createWebhook,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await createWebhook(\n {\n targetUrl: 'https://yourwebhook.com',\n event: 'file.uploaded',\n isActive: true,\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "webhook();\n$result = $api->createWebhook('https://yourwebhook.com', true, 'sign-secret', 'file.uploaded');\necho \\sprintf('Webhook %s created', $result->getId());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, Webhook\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nwebhook = uploadcare.webhooks_api.create(\n {\n \"event\": \"file.uploaded\",\n \"target_url\": \"https://yourwebhook.com\",\n \"is_active\": True,\n }\n)\nprint(webhook)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\noptions = {\n target_url: \"https://yourwebhook.com\",\n event: \"file.uploaded\",\n is_active: true\n}\nUploadcare::Webhook.create(**options)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet url = URL(string: \"https://yourwebhook.com\")!\nlet webhook = try await uploadcare.createWebhook(targetUrl: url, event: .fileUploaded, isActive: true, signingSecret: \"sign-secret\")\nprint(webhook)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval url = URI(\"https://yourwebhook.com\")\nval webhook = uploadcare.createWebhook(\n targetUrl = url,\n event = EventType.UPLOADED,\n isActive = true,\n signingSecret = \"sign-secret\"\n)\nLog.d(\"TAG\", webhook.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/webhooks \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/webhooks \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/webhooks \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/webhooks \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_webhook.updateWebhook": { + "id": "subpackage_webhook.updateWebhook", + "namespace": [ + "subpackage_webhook" + ], + "description": "Update webhook attributes.", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/webhooks/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Webhook ID." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_:Webhook" + } + } + }, + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/webhooks/143", + "responseStatusCode": 200, + "pathParameters": { + "id": 143 + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "id": 1, + "project": 13, + "created": "2016-04-27T11:49:54Z", + "updated": "2016-04-27T12:04:57Z", + "event": "file.infected", + "target_url": "http://example.com/hooks/receiver", + "is_active": true, + "version": "0.7", + "signing_secret": "7kMVZivndx0ErgvhRKAr" + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n updateWebhook,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await updateWebhook(\n {\n id: 1473151,\n targetUrl: 'https://yourwebhook.com',\n event: 'file.uploaded',\n isActive: true,\n signingSecret: 'webhook-secret',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "webhook();\n$webhook = $api->updateWebhook(1473151, [\n 'target_url' => 'https://yourwebhook.com',\n 'event' => 'file.uploaded',\n 'is_active' => true,\n 'signing_secret' => 'webhook-secret',\n]);\n\\sprintf(\"Webhook with url %s is %s\\n\", $webhook->getTargetUrl(), $webhook->isActive() ? 'active' : 'not active');\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, Webhook\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nwebhook_id = 1473151\nwebhook = uploadcare.webhooks_api.update(webhook_id, {\"is_active\": False})\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nwebhook_id = 1473151\noptions = {\n target_url: 'https://yourwebhook.com',\n event: 'file.uploaded',\n is_active: true,\n signing_secret: 'webhook-secret'\n}\nUploadcare::Webhook.update(webhook_id, options)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet url = URL(string: \"https://yourwebhook.com\")!\nlet webhook = try await uploadcare.updateWebhook(id: 1473151, targetUrl: url, event: .fileInfoUpdated, isActive: true, signingSecret: \"webhook-secret\")\nprint(webhook)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval url = URI(\"https://yourwebhook.com\")\nval webhook = uploadcare.updateWebhook(\n webhookId = 1473151,\n targetUrl = url,\n event = EventType.UPLOADED,\n isActive = true,\n signingSecret = \"\",\n)\nLog.d(\"TAG\", webhook.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/webhooks/143 \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks/1", + "responseStatusCode": 401, + "pathParameters": { + "id": 1 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/webhooks/1 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks/1", + "responseStatusCode": 404, + "pathParameters": { + "id": 1 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/webhooks/1 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks/1", + "responseStatusCode": 429, + "pathParameters": { + "id": 1 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X PUT https://api.uploadcare.com/webhooks/1 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_webhook.unsubscribe": { + "id": "subpackage_webhook.unsubscribe", + "namespace": [ + "subpackage_webhook" + ], + "description": "Unsubscribe and delete a webhook.", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/webhooks/unsubscribe" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/webhooks/unsubscribe", + "responseStatusCode": 204, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n deleteWebhook,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await deleteWebhook(\n {\n targetUrl: 'https://yourwebhook.com',\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "webhook();\n$result = $api->deleteWebhook('https://yourwebhook.com');\necho $result ? 'Webhook has been deleted' : 'Webhook is not deleted, something went wrong';\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare, Webhook\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nwebhook_id = 1473151\nuploadcare.delete_webhook(webhook_id)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nputs Uploadcare::Webhook.delete('https://yourwebhook.com')\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet url = URL(string: \"https://yourwebhook.com\")!\ntry await uploadcare.deleteWebhook(forTargetUrl: url)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval url = URI(\"https://yourwebhook.com\")\nuploadcare.deleteWebhook(url)\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/webhooks/unsubscribe \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks/unsubscribe", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/webhooks/unsubscribe \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks/unsubscribe", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/webhooks/unsubscribe \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/webhooks/unsubscribe", + "responseStatusCode": 429, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X DELETE https://api.uploadcare.com/webhooks/unsubscribe \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_conversion.documentConvertInfo": { + "id": "subpackage_conversion.documentConvertInfo", + "namespace": [ + "subpackage_conversion" + ], + "description": "The endpoint allows you to determine the document format and possible conversion formats.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/convert/document/" + }, + { + "type": "pathParameter", + "value": "uuid" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File uuid." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_conversion:DocumentConvertInfoResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/convert/document/86c91c35-58e1-41f7-9b23-2d7652cfcd17", + "responseStatusCode": 200, + "pathParameters": { + "uuid": "86c91c35-58e1-41f7-9b23-2d7652cfcd17" + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "error": "error", + "format": { + "name": "txt", + "conversion_formats": [ + { + "name": "epub" + }, + { + "name": "pdf" + } + ] + }, + "converted_groups": { + "{conversion_format}": "{conversion_format}" + } + } + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/86c91c35-58e1-41f7-9b23-2d7652cfcd17 \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/:uuid", + "responseStatusCode": 400, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/:uuid", + "responseStatusCode": 401, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/:uuid", + "responseStatusCode": 404, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/:uuid", + "responseStatusCode": 429, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/:uuid", + "responseStatusCode": 503, + "pathParameters": { + "uuid": ":uuid" + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/:uuid \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_conversion.documentConvert": { + "id": "subpackage_conversion.documentConvert", + "namespace": [ + "subpackage_conversion" + ], + "description": "Uploadcare allows you to convert files to different target formats. Check out the [conversion capabilities](https://uploadcare.com/docs/transformations/document-conversion/#document-file-formats) for each supported format.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/convert/document" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paths", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "An array of UUIDs of your source documents to convert together with the specified target format (see [documentation](https://uploadcare.com/docs/transformations/document-conversion/))." + }, + { + "key": "store", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:DocumentJobSubmitParametersStore" + } + }, + "description": "When `store` is set to `\"0\"`, the converted files will only be available for 24 hours. `\"1\"` makes converted files available permanently. If the parameter is omitted, it checks the `Auto file storing` setting of your Uploadcare project identified by the `public_key` provided in the `auth-param`.\n" + }, + { + "key": "save_in_group", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:DocumentJobSubmitParametersSaveInGroup" + } + }, + "description": "When `save_in_group` is set to `\"1\"`, multi-page documents additionally will be saved as a file group.\n" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_conversion:DocumentConvertResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/convert/document", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paths": [ + "https://cdn.uploadcare.com/5ffa2545-ea40-4e71-a9e4-3a8e49b7b737/document/-/format/jpg/-/page/1/", + "88a51210-bd69-4411-bc72-a9952d9512cd/document/-/format/pdf/", + "8ddbbb48-0927-4df7-afac-c6031668b01b/document/" + ], + "store": "0", + "save_in_group": "1" + } + }, + "responseBody": { + "type": "json", + "value": { + "problems": { + "8ddbbb48-0927-4df7-afac-c6031668b01b": "Bad path \"8ddbbb48-0927-4df7-afac-c6031668b01b\". Use UUID or CDN URL" + }, + "result": [ + { + "original_source": "https://cdn.uploadcare.com/5ffa2545-ea40-4e71-a9e4-3a8e49b7b737/document/-/format/jpg/-/page/1/", + "uuid": "d52d7136-a2e5-4338-9f45-affbf83b857d", + "token": 445630631 + }, + { + "original_source": "88a51210-bd69-4411-bc72-a9952d9512cd/document/-/format/pdf/", + "uuid": "28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2", + "token": 445630637 + } + ] + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "conversion();\n$request = new Uploadcare\\Conversion\\DocumentConversionRequest('pdf');\n$result = $api->convertDocument('1bac376c-aa7e-4356-861b-dd2657b5bfd2', $request);\nif ($result instanceof ConvertedItemInterface) {\n echo \\sprintf('Conversion requested. Key is \\'%s\\'', $result->getToken());\n}\nif ($result instanceof ResponseProblemInterface) {\n echo \\sprintf('Error in request: %s', $result->getReason());\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\nfile = uploadcare.file('1bac376c-aa7e-4356-861b-dd2657b5bfd2')\ntransformation = DocumentTransformation().format(DocumentFormat.pdf)\nconverted_file = file.convert(transformation)\nprint(converted_file.info)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\ndocument_params = { uuid: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\", format: :pdf }\noptions = { store: true }\nUploadcare::DocumentConverter.convert(document_params, options)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet file = try await uploadcare.fileInfo(withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nlet settings = DocumentConversionJobSettings(forFile: file)\n .format(.pdf)\n \nlet response = try await uploadcare.convertDocumentsWithSettings([settings])\nprint(response)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval conversionJob = DocumentConversionJob(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\n .apply { setFormat(DocumentFormat.PDF) }\nval converter = DocumentConverter(uploadcare, listOf(conversionJob))\nval files = converter.convert()\nLog.d(\"TAG\", files.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/convert/document \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paths\": [\n \"https://cdn.uploadcare.com/5ffa2545-ea40-4e71-a9e4-3a8e49b7b737/document/-/format/jpg/-/page/1/\",\n \"88a51210-bd69-4411-bc72-a9952d9512cd/document/-/format/pdf/\",\n \"8ddbbb48-0927-4df7-afac-c6031668b01b/document/\"\n ],\n \"store\": \"0\",\n \"save_in_group\": \"1\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/convert/document", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/convert/document \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/convert/document", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/convert/document \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_conversion.documentConvertStatus": { + "id": "subpackage_conversion.documentConvertStatus", + "namespace": [ + "subpackage_conversion" + ], + "description": "Once you get a conversion job result, you can acquire a conversion job status via token. Just put it in your request URL as `:token`.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/convert/document/status/" + }, + { + "type": "pathParameter", + "value": "token" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Job token." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_conversion:DocumentConvertStatusResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/convert/document/status/1", + "responseStatusCode": 200, + "pathParameters": { + "token": 1 + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "processing", + "error": "error", + "result": { + "uuid": "500196bc-9da5-4aaf-8f3e-70a4ce86edae" + } + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n conversionJobStatus,\n ConversionType,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await conversionJobStatus(\n {\n type: ConversionType.DOCUMENT,\n token: 32921143\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "conversion();\n$status = $api->documentJobStatus(32921143);\necho \\sprintf('Conversion status: %s', $status->getError() ?? $status->getStatus());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\ntoken = 32921143\ndocument_convert_status = uploadcare.document_convert_api.status(token)\nprint(document_convert_status.status)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\ntoken = 32921143\nputs Uploadcare::DocumentConverter.status(token)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet job = try await uploadcare.documentConversionJobStatus(token: 32921143)\nprint(job.statusString)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval status = uploadcare.getDocumentConversionStatus(token = 32921143)\nLog.d(\"TAG\", status.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/status/1 \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/status/0", + "responseStatusCode": 400, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/status/0", + "responseStatusCode": 401, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/status/0", + "responseStatusCode": 404, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/status/0", + "responseStatusCode": 429, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/document/status/0", + "responseStatusCode": 503, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/document/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + }, + "subpackage_conversion.videoConvert": { + "id": "subpackage_conversion.videoConvert", + "namespace": [ + "subpackage_conversion" + ], + "description": "Uploadcare video processing adjusts video quality, format (mp4, webm, ogg), and size, cuts it, and generates thumbnails. Processed video is instantly available over CDN.", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/convert/video" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "request": { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "paths", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "An array of UUIDs of your video files to process together with a set of assigned operations (see [documentation](https://uploadcare.com/docs/transformations/video-encoding/))." + }, + { + "key": "store", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:VideoJobSubmitParametersStore" + } + }, + "description": "When `store` is set to `\"0\"`, the converted files will only be available for 24 hours. `\"1\"` makes converted files available permanently. If the parameter is omitted, it checks the `Auto file storing` setting of your Uploadcare project identified by the `public_key` provided in the `auth-param`.\n" + } + ] + } + }, + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_conversion:VideoConvertResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/convert/video", + "responseStatusCode": 200, + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "type": "json", + "value": { + "paths": [ + "d52d7136-a2e5-4338-9f45-affbf83b857d/video/", + "d52d7136-a2e5-4338-9f45-affbf83b857d/video/-/format/ogg/-/quality/best/", + "28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2" + ], + "store": "1" + } + }, + "responseBody": { + "type": "json", + "value": { + "problems": { + "13cd56e2-f6d7-4c66-ab1b-ffd13cd6646d": "Bad path \"13cd56e2-f6d7-4c66-ab1b-ffd13cd6646d\". Use UUID or CDN URL" + }, + "result": [ + { + "original_source": "d52d7136-a2e5-4338-9f45-affbf83b857d/video/-/format/ogg/-/quality/best/", + "uuid": "d52d7136-a2e5-4338-9f45-affbf83b857d", + "token": 445630631, + "thumbnails_group_uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46~1" + }, + { + "original_source": "500196bc-9da5-4aaf-8f3e-70a4ce86edae/video/", + "uuid": "28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2", + "token": 445630637, + "thumbnails_group_uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb~1" + } + ] + } + }, + "snippets": { + "php": [ + { + "name": "PHP", + "language": "php", + "code": "conversion();\n$request = (new Uploadcare\\Conversion\\VideoEncodingRequest())\n ->setHorizontalSize(1024)\n ->setVerticalSize(768)\n ->setResizeMode('preserve_ratio')\n ->setTargetFormat('mp4');\n$result = $api->convertVideo('1bac376c-aa7e-4356-861b-dd2657b5bfd2', $request);\nif ($result instanceof ConvertedItemInterface) {\n echo \\sprintf('Conversion requested. Key is \\'%s\\'', $result->getToken());\n}\nif ($result instanceof ResponseProblemInterface) {\n echo \\sprintf('Error in request: %s', $result->getReason());\n}\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\ntransformation = (\n VideoTransformation()\n .format(VideoFormat.mp4)\n .size(width=640, height=480, resize_mode=ResizeMode.add_padding)\n .quality(Quality.lighter)\n .cut(start_time=\"0:1.535\", length=\"0:10.0\")\n .thumbs(10)\n)\n\npath = transformation.path('1bac376c-aa7e-4356-861b-dd2657b5bfd2')\nresponse = uploadcare.video_convert_api.convert([path])\nvideo_convert_info = response.result[0]\nconverted_file = uploadcare.file(video_convert_info.uuid)\nvideo_convert_status = uploadcare.video_convert_api.status(video_convert_info.token)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\nvideo_params = {\n uuid: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\",\n format: :mp4,\n quality: :lighter\n}\noptions = { store: true }\nUploadcare::VideoConverter.convert(video_params, options)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet file = try await uploadcare.fileInfo(withUUID: \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\nlet settings = VideoConversionJobSettings(forFile: videoFile)\n .format(.mp4)\n .size(VideoSize(width: 640, height: 480))\n .resizeMode(.addPadding)\n .quality(.lighter)\n .cut( VideoCut(startTime: \"0:0:5.000\", length: \"15\") )\n .thumbs(10)\n\nlet response = try await uploadcare.convertVideosWithSettings([settings])\nprint(response)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval conversionJob = VideoConversionJob(fileId = \"1bac376c-aa7e-4356-861b-dd2657b5bfd2\")\n .apply {\n setFormat(VideoFormat.MP4)\n resize(width = 640, height = 480, resizeMode = VideoResizeMode.LETTERBOX)\n quality(VideoQuality.LIGHTER)\n cut(startTime = \"0:0:5.000\", length = \"15\")\n thumbnails(10)\n }\nval converter = VideoConverter(uploadcare, listOf(conversionJob))\nval files = converter.convert()\nLog.d(\"TAG\", files.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/convert/video \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"paths\": [\n \"d52d7136-a2e5-4338-9f45-affbf83b857d/video/\",\n \"d52d7136-a2e5-4338-9f45-affbf83b857d/video/-/format/ogg/-/quality/best/\",\n \"28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2\"\n ],\n \"store\": \"1\"\n}'", + "generated": true + } + ] + } + }, + { + "path": "/convert/video", + "responseStatusCode": 400, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/convert/video \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + }, + { + "path": "/convert/video", + "responseStatusCode": 401, + "pathParameters": {}, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "requestBody": { + "type": "json", + "value": {} + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl -X POST https://api.uploadcare.com/convert/video \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \" \\\n -H \"Content-Type: application/json\" \\\n -d '{}'", + "generated": true + } + ] + } + } + ] + }, + "subpackage_conversion.videoConvertStatus": { + "id": "subpackage_conversion.videoConvertStatus", + "namespace": [ + "subpackage_conversion" + ], + "description": "Once you get a processing job result, you can acquire a processing job status via token. Just put it in your request URL as `:token`.", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/convert/video/status/" + }, + { + "type": "pathParameter", + "value": "token" + } + ], + "auth": [ + "default" + ], + "defaultEnvironment": "Default", + "environments": [ + { + "id": "Default", + "baseUrl": "https://api.uploadcare.com" + } + ], + "pathParameters": [ + { + "key": "token", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Job token." + } + ], + "response": { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "type_conversion:VideoConvertStatusResponse" + } + } + }, + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 429, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + }, + { + "statusCode": 503, + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + ], + "examples": [ + { + "path": "/convert/video/status/1", + "responseStatusCode": 200, + "pathParameters": { + "token": 1 + }, + "queryParameters": {}, + "headers": {}, + "responseBody": { + "type": "json", + "value": { + "status": "processing", + "error": "error", + "result": { + "uuid": "500196bc-9da5-4aaf-8f3e-70a4ce86edae", + "thumbnails_group_uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46~1" + } + } + }, + "snippets": { + "javascript": [ + { + "name": "JS", + "language": "javascript", + "code": "import {\n conversionJobStatus,\n ConversionType,\n UploadcareSimpleAuthSchema,\n} from '@uploadcare/rest-client';\n\nconst uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({\n publicKey: 'YOUR_PUBLIC_KEY',\n secretKey: 'YOUR_SECRET_KEY',\n});\n\nconst result = await conversionJobStatus(\n {\n type: ConversionType.VIDEO,\n token: 1201016744\n },\n { authSchema: uploadcareSimpleAuthSchema }\n)\n", + "generated": false + } + ], + "php": [ + { + "name": "PHP", + "language": "php", + "code": "conversion();\n$status = $api->videoJobStatus(1201016744);\necho \\sprintf('Conversion status: %s', $status->getError() ?? $status->getStatus());\n", + "generated": false + } + ], + "python": [ + { + "name": "Python", + "language": "python", + "code": "from pyuploadcare import Uploadcare\nuploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')\n\ntoken = 1201016744\nvideo_convert_status = uploadcare.video_convert_api.status(token)\nprint(video_convert_status.status)\n", + "generated": false + } + ], + "ruby": [ + { + "name": "Ruby", + "language": "ruby", + "code": "require 'uploadcare'\nUploadcare.config.public_key = \"YOUR_PUBLIC_KEY\"\nUploadcare.config.secret_key = \"YOUR_SECRET_KEY\"\n\ntoken = 1201016744\nputs Uploadcare::VideoConverter.status(token)\n", + "generated": false + } + ], + "swift": [ + { + "name": "Swift", + "language": "swift", + "code": "import Uploadcare\n\nlet uploadcare = Uploadcare(withPublicKey: \"YOUR_PUBLIC_KEY\", secretKey: \"YOUR_SECRET_KEY\")\n\nlet job = try await uploadcare.videoConversionJobStatus(token: 1201016744)\nprint(job.statusString)\n", + "generated": false + } + ], + "kotlin": [ + { + "name": "Kotlin", + "language": "kotlin", + "code": "import com.uploadcare.android.library.api.UploadcareClient\n\nval uploadcare = UploadcareClient(publicKey = \"YOUR_PUBLIC_KEY\", secretKey = \"YOUR_SECRET_KEY\")\n\nval status = uploadcare.getVideoConversionStatus(token = 1201016744)\nLog.d(\"TAG\", status.toString())\n", + "generated": false + } + ], + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/video/status/1 \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/video/status/0", + "responseStatusCode": 400, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/video/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/video/status/0", + "responseStatusCode": 401, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/video/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/video/status/0", + "responseStatusCode": 404, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/video/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/video/status/0", + "responseStatusCode": 429, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/video/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + }, + { + "path": "/convert/video/status/0", + "responseStatusCode": 503, + "pathParameters": { + "token": 0 + }, + "queryParameters": {}, + "headers": { + "Accept": "string", + "Uploadcare": "string", + "Uploadcare.Simple": "string" + }, + "responseBody": { + "type": "json", + "value": {} + }, + "snippets": { + "curl": [ + { + "language": "curl", + "code": "curl https://api.uploadcare.com/convert/video/status/0 \\\n -H \"Accept: string\" \\\n -H \"Uploadcare: string\" \\\n -H \"Uploadcare.Simple: string\" \\\n -H \"Authorization: \"", + "generated": true + } + ] + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "type_file:FilesListRequestOrdering": { + "name": "FilesListRequestOrdering", + "shape": { + "type": "enum", + "values": [ + { + "value": "datetime_uploaded" + }, + { + "value": "-datetime_uploaded" + } + ] + } + }, + "type_file:FilesListResponseTotals": { + "name": "FilesListResponseTotals", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "removed", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Total number of the files that are marked as removed." + }, + { + "key": "stored", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Total number of the files that are marked as stored." + }, + { + "key": "unstored", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Total number of the files that are not marked as stored." + } + ] + } + }, + "type_file:FilesListResponse": { + "name": "FilesListResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "next", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Next page URL." + }, + { + "key": "previous", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Previous page URL." + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Total number of the files of the queried type. The queried type depends on the stored and removed query parameters." + }, + { + "key": "totals", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_file:FilesListResponseTotals" + } + } + }, + { + "key": "per_page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Number of the files per page." + }, + { + "key": "results", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:File" + } + } + } + } + ] + } + }, + "type_file:FilesStoringResponse": { + "name": "FilesStoringResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "problems", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Dictionary of passed files UUIDs and problems associated with these UUIDs." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:File" + } + } + }, + "description": "List of file objects that have been stored/deleted." + } + ] + } + }, + "type_file:FilesDeleteResponse": { + "name": "FilesDeleteResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "problems", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Dictionary of passed files UUIDs and problems associated with these UUIDs." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:File" + } + } + }, + "description": "List of file objects that have been stored/deleted." + } + ] + } + }, + "type_file:CreateLocalCopyRequestStore": { + "name": "CreateLocalCopyRequestStore", + "description": "The parameter only applies to the Uploadcare storage and MUST be either true or false.", + "shape": { + "type": "enum", + "values": [ + { + "value": "true" + }, + { + "value": "false" + } + ] + } + }, + "type_file:CreateRemoteCopyRequestPattern": { + "name": "CreateRemoteCopyRequestPattern", + "description": "The parameter is used to specify file names Uploadcare passes to a custom storage. If the parameter is omitted, your custom storages pattern is used. Use any combination of allowed values.\n\nParameter values:\n\n- `${default}` = `${uuid}/${auto_filename}`\n- `${auto_filename}` = `${filename}${effects}${ext}`\n- `${effects}` = processing operations put into a CDN URL\n- `${filename}` = original filename without extension\n- `${uuid}` = file UUID\n- `${ext}` = file extension, including period, e.g. .jpg", + "shape": { + "type": "enum", + "values": [ + { + "value": "${default}" + }, + { + "value": "${auto_filename}" + }, + { + "value": "${effects}" + }, + { + "value": "${filename}" + }, + { + "value": "${uuid}" + }, + { + "value": "${ext}" + } + ] + } + }, + "type_addOns:AwsRekognitionExecuteResponse": { + "name": "AwsRekognitionExecuteResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "request_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Request ID." + } + ] + } + }, + "type_addOns:AwsRekognitionExecutionStatusResponseStatus": { + "name": "AwsRekognitionExecutionStatusResponseStatus", + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution.", + "shape": { + "type": "enum", + "values": [ + { + "value": "in_progress" + }, + { + "value": "error" + }, + { + "value": "done" + }, + { + "value": "unknown" + } + ] + } + }, + "type_addOns:AwsRekognitionExecutionStatusResponse": { + "name": "AwsRekognitionExecutionStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:AwsRekognitionExecutionStatusResponseStatus" + } + }, + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution." + } + ] + } + }, + "type_addOns:AwsRekognitionDetectModerationLabelsExecuteResponse": { + "name": "AwsRekognitionDetectModerationLabelsExecuteResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "request_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Request ID." + } + ] + } + }, + "type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus": { + "name": "AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus", + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution.", + "shape": { + "type": "enum", + "values": [ + { + "value": "in_progress" + }, + { + "value": "error" + }, + { + "value": "done" + }, + { + "value": "unknown" + } + ] + } + }, + "type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponse": { + "name": "AwsRekognitionDetectModerationLabelsExecutionStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:AwsRekognitionDetectModerationLabelsExecutionStatusResponseStatus" + } + }, + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution." + } + ] + } + }, + "type_addOns:UcClamavVirusScanExecuteRequestParams": { + "name": "UcClamavVirusScanExecuteRequestParams", + "description": "Optional object with Add-On specific parameters", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "purge_infected", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Purge infected file." + } + ] + } + }, + "type_addOns:UcClamavVirusScanExecuteResponse": { + "name": "UcClamavVirusScanExecuteResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "request_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Request ID." + } + ] + } + }, + "type_addOns:UcClamavVirusScanExecutionStatusResponseStatus": { + "name": "UcClamavVirusScanExecutionStatusResponseStatus", + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution.", + "shape": { + "type": "enum", + "values": [ + { + "value": "in_progress" + }, + { + "value": "error" + }, + { + "value": "done" + }, + { + "value": "unknown" + } + ] + } + }, + "type_addOns:UcClamavVirusScanExecutionStatusResponse": { + "name": "UcClamavVirusScanExecutionStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:UcClamavVirusScanExecutionStatusResponseStatus" + } + }, + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution." + } + ] + } + }, + "type_addOns:RemoveBgExecuteRequestParamsTypeLevel": { + "name": "RemoveBgExecuteRequestParamsTypeLevel", + "description": "\"none\" = No classification (foreground_type won't bet set in the application data)\n\n\"1\" = Use coarse classification classes: [person, product, animal, car, other]\n\n\"2\" = Use more specific classification classes: [person, product, animal, car,\ncar_interior, car_part, transportation, graphics, other]\n\n\"latest\" = Always use the latest classification classes available", + "shape": { + "type": "enum", + "values": [ + { + "value": "none" + }, + { + "value": "1" + }, + { + "value": "2" + }, + { + "value": "latest" + } + ] + } + }, + "type_addOns:RemoveBgExecuteRequestParamsType": { + "name": "RemoveBgExecuteRequestParamsType", + "description": "Foreground type.", + "shape": { + "type": "enum", + "values": [ + { + "value": "auto" + }, + { + "value": "person" + }, + { + "value": "product" + }, + { + "value": "car" + } + ] + } + }, + "type_addOns:RemoveBgExecuteRequestParamsChannels": { + "name": "RemoveBgExecuteRequestParamsChannels", + "description": "Request either the finalized image ('rgba', default) or an alpha mask ('alpha').", + "shape": { + "type": "enum", + "values": [ + { + "value": "rgba" + }, + { + "value": "alpha" + } + ] + } + }, + "type_addOns:RemoveBgExecuteRequestParams": { + "name": "RemoveBgExecuteRequestParams", + "description": "Optional object with Add-On specific parameters", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "crop", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to crop off all empty regions" + }, + { + "key": "crop_margin", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Adds a margin around the cropped subject, e.g 30px or 30%" + }, + { + "key": "scale", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Scales the subject relative to the total image size, e.g 80%" + }, + { + "key": "add_shadow", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to add an artificial shadow to the result" + }, + { + "key": "type_level", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:RemoveBgExecuteRequestParamsTypeLevel" + } + }, + "description": "\"none\" = No classification (foreground_type won't bet set in the application data)\n\n\"1\" = Use coarse classification classes: [person, product, animal, car, other]\n\n\"2\" = Use more specific classification classes: [person, product, animal, car,\ncar_interior, car_part, transportation, graphics, other]\n\n\"latest\" = Always use the latest classification classes available" + }, + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:RemoveBgExecuteRequestParamsType" + } + }, + "description": "Foreground type." + }, + { + "key": "semitransparency", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether to have semi-transparent regions in the result" + }, + { + "key": "channels", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:RemoveBgExecuteRequestParamsChannels" + } + }, + "description": "Request either the finalized image ('rgba', default) or an alpha mask ('alpha')." + }, + { + "key": "roi", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Region of interest: Only contents of this rectangular region can be detected\nas foreground. Everything outside is considered background and will be removed.\nThe rectangle is defined as two x/y coordinates in the format \"x1 y1 x2 y2\".\nThe coordinates can be in absolute pixels (suffix 'px') or relative to the\nwidth/height of the image (suffix '%'). By default, the whole image is the\nregion of interest (\"0% 0% 100% 100%\")." + }, + { + "key": "position", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Positions the subject within the image canvas. Can be \"original\"\n(default unless \"scale\" is given), \"center\" (default when \"scale\" is given) or a value from \"0%\" to \"100%\"\n(both horizontal and vertical) or two values (horizontal, vertical)." + } + ] + } + }, + "type_addOns:RemoveBgExecuteResponse": { + "name": "RemoveBgExecuteResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "request_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Request ID." + } + ] + } + }, + "type_addOns:RemoveBgExecutionStatusResponseResult": { + "name": "RemoveBgExecutionStatusResponseResult", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "file_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "UUID of the file with removed background." + } + ] + } + }, + "type_addOns:RemoveBgExecutionStatusResponse": { + "name": "RemoveBgExecutionStatusResponse", + "shape": { + "type": "object", + "extends": [ + "type_:AddonExecutionStatus" + ], + "properties": [ + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_addOns:RemoveBgExecutionStatusResponseResult" + } + } + } + ] + } + }, + "type_group:GroupsListRequestOrdering": { + "name": "GroupsListRequestOrdering", + "shape": { + "type": "enum", + "values": [ + { + "value": "datetime_created" + }, + { + "value": "-datetime_created" + } + ] + } + }, + "type_group:GroupsListResponse": { + "name": "GroupsListResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "next", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Next page URL." + }, + { + "key": "previous", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Previous page URL." + }, + { + "key": "total", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Total number of groups in the project." + }, + { + "key": "per_page", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "Number of groups per page." + }, + { + "key": "results", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:Group" + } + } + } + } + ] + } + }, + "type_conversion:DocumentConvertInfoResponseFormatConversionFormatsItem": { + "name": "DocumentConvertInfoResponseFormatConversionFormatsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Supported target document format." + } + ] + } + }, + "type_conversion:DocumentConvertInfoResponseFormat": { + "name": "DocumentConvertInfoResponseFormat", + "description": "Document format details.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A detected document format." + }, + { + "key": "conversion_formats", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_conversion:DocumentConvertInfoResponseFormatConversionFormatsItem" + } + } + }, + "description": "The conversions that are supported for the document." + } + ] + } + }, + "type_conversion:DocumentConvertInfoResponseConvertedGroups": { + "name": "DocumentConvertInfoResponseConvertedGroups", + "description": "Information about already converted groups.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "{conversion_format}", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Converted group UUID." + } + ] + } + }, + "type_conversion:DocumentConvertInfoResponse": { + "name": "DocumentConvertInfoResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Holds an error if your document can't be handled." + }, + { + "key": "format", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:DocumentConvertInfoResponseFormat" + } + }, + "description": "Document format details." + }, + { + "key": "converted_groups", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:DocumentConvertInfoResponseConvertedGroups" + } + }, + "description": "Information about already converted groups." + } + ] + } + }, + "type_conversion:DocumentJobSubmitParametersStore": { + "name": "DocumentJobSubmitParametersStore", + "description": "When `store` is set to `\"0\"`, the converted files will only be available for 24 hours. `\"1\"` makes converted files available permanently. If the parameter is omitted, it checks the `Auto file storing` setting of your Uploadcare project identified by the `public_key` provided in the `auth-param`.", + "shape": { + "type": "enum", + "values": [ + { + "value": "0" + }, + { + "value": "false" + }, + { + "value": "1" + }, + { + "value": "true" + } + ] + } + }, + "type_conversion:DocumentJobSubmitParametersSaveInGroup": { + "name": "DocumentJobSubmitParametersSaveInGroup", + "description": "When `save_in_group` is set to `\"1\"`, multi-page documents additionally will be saved as a file group.", + "shape": { + "type": "enum", + "values": [ + { + "value": "0" + }, + { + "value": "false" + }, + { + "value": "1" + }, + { + "value": "true" + } + ] + } + }, + "type_conversion:DocumentConvertResponseResultItem": { + "name": "DocumentConvertResponseResultItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "original_source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Source file identifier including a target format, if present." + }, + { + "key": "uuid", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A UUID of your converted document." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A conversion job token that can be used to get a job status." + } + ] + } + }, + "type_conversion:DocumentConvertResponse": { + "name": "DocumentConvertResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "problems", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Dictionary of problems related to your processing job, if any. A key is the `path` you requested." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_conversion:DocumentConvertResponseResultItem" + } + } + }, + "description": "Result for each requested path, in case of no errors for that path." + } + ] + } + }, + "type_conversion:DocumentConvertStatusResponseStatus": { + "name": "DocumentConvertStatusResponseStatus", + "description": "Conversion job status, can have one of the following values: - `pending` — a source file is being prepared for conversion. - `processing` — conversion is in progress. - `finished` — the conversion is finished. - `failed` — failed to convert the source, see `error` for details. - `canceled` — the conversion was canceled.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "processing" + }, + { + "value": "finished" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + }, + "type_conversion:DocumentConvertStatusResponseResult": { + "name": "DocumentConvertStatusResponseResult", + "description": "Repeats the contents of your processing output.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "uuid", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A UUID of a converted target file." + } + ] + } + }, + "type_conversion:DocumentConvertStatusResponse": { + "name": "DocumentConvertStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:DocumentConvertStatusResponseStatus" + } + }, + "description": "Conversion job status, can have one of the following values: - `pending` — a source file is being prepared for conversion. - `processing` — conversion is in progress. - `finished` — the conversion is finished. - `failed` — failed to convert the source, see `error` for details. - `canceled` — the conversion was canceled." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Holds a conversion error if your file can't be handled." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:DocumentConvertStatusResponseResult" + } + }, + "description": "Repeats the contents of your processing output." + } + ] + } + }, + "type_conversion:VideoJobSubmitParametersStore": { + "name": "VideoJobSubmitParametersStore", + "description": "When `store` is set to `\"0\"`, the converted files will only be available for 24 hours. `\"1\"` makes converted files available permanently. If the parameter is omitted, it checks the `Auto file storing` setting of your Uploadcare project identified by the `public_key` provided in the `auth-param`.", + "shape": { + "type": "enum", + "values": [ + { + "value": "0" + }, + { + "value": "false" + }, + { + "value": "1" + }, + { + "value": "true" + } + ] + } + }, + "type_conversion:VideoConvertResponseResultItem": { + "name": "VideoConvertResponseResultItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "original_source", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Input file identifier including operations, if present." + }, + { + "key": "uuid", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A UUID of your processed video file." + }, + { + "key": "token", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A processing job token that can be used to get a job status." + }, + { + "key": "thumbnails_group_uuid", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "UUID of a file group with thumbnails for an output video, based on the `thumbs` operation parameters." + } + ] + } + }, + "type_conversion:VideoConvertResponse": { + "name": "VideoConvertResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "problems", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "description": "Dictionary of problems related to your processing job, if any. Key is the `path` you requested." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_conversion:VideoConvertResponseResultItem" + } + } + }, + "description": "Result for each requested path, in case of no errors for that path." + } + ] + } + }, + "type_conversion:VideoConvertStatusResponseStatus": { + "name": "VideoConvertStatusResponseStatus", + "description": "Processing job status, can have one of the following values: - `pending` — video file is being prepared for conversion. - `processing` — video file processing is in progress. - `finished` — the processing is finished. - `failed` — we failed to process the video, see `error` for details. - `canceled` — video processing was canceled.", + "shape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "processing" + }, + { + "value": "finished" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + }, + "type_conversion:VideoConvertStatusResponseResult": { + "name": "VideoConvertStatusResponseResult", + "description": "Repeats the contents of your processing output.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "uuid", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A UUID of your processed video file." + }, + { + "key": "thumbnails_group_uuid", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A UUID of a file group with thumbnails for an output video, based on the `thumbs` operation parameters." + } + ] + } + }, + "type_conversion:VideoConvertStatusResponse": { + "name": "VideoConvertStatusResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:VideoConvertStatusResponseStatus" + } + }, + "description": "Processing job status, can have one of the following values: - `pending` — video file is being prepared for conversion. - `processing` — video file processing is in progress. - `finished` — the processing is finished. - `failed` — we failed to process the video, see `error` for details. - `canceled` — video processing was canceled." + }, + { + "key": "error", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Holds a processing error if we failed to handle your video." + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_conversion:VideoConvertStatusResponseResult" + } + }, + "description": "Repeats the contents of your processing output." + } + ] + } + }, + "type_:AddonExecutionStatusStatus": { + "name": "AddonExecutionStatusStatus", + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution.", + "shape": { + "type": "enum", + "values": [ + { + "value": "in_progress" + }, + { + "value": "error" + }, + { + "value": "done" + }, + { + "value": "unknown" + } + ] + } + }, + "type_:AddonExecutionStatus": { + "name": "AddonExecutionStatus", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AddonExecutionStatusStatus" + } + }, + "description": "Defines the status of an Add-On execution.\nIn most cases, once the status changes to `done`, [Application Data](#operation/fileInfo) of the file that had been specified as a `appdata`, will contain the result of the execution." + } + ] + } + }, + "type_:WebhookFilePayload": { + "name": "WebhookFilePayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "initiator", + "valueShape": { + "type": "id", + "id": "type_:WebhookInitiator" + } + }, + { + "key": "hook", + "valueShape": { + "type": "id", + "id": "type_:WebhookPublicInfo" + } + }, + { + "key": "data", + "valueShape": { + "type": "id", + "id": "type_:File" + } + }, + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File CDN URL." + } + ] + } + }, + "type_:WebhookFileInfoUpdatedPayloadPreviousValues": { + "name": "WebhookFileInfoUpdatedPayloadPreviousValues", + "description": "Object containing the values of the updated file data attributes and their values prior to the event.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "appdata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ApplicationDataObject" + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Metadata" + } + } + } + ] + } + }, + "type_:WebhookFileInfoUpdatedPayload": { + "name": "WebhookFileInfoUpdatedPayload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "initiator", + "valueShape": { + "type": "id", + "id": "type_:WebhookInitiator" + } + }, + { + "key": "hook", + "valueShape": { + "type": "id", + "id": "type_:WebhookPublicInfo" + } + }, + { + "key": "data", + "valueShape": { + "type": "id", + "id": "type_:File" + } + }, + { + "key": "file", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File CDN URL." + }, + { + "key": "previous_values", + "valueShape": { + "type": "id", + "id": "type_:WebhookFileInfoUpdatedPayloadPreviousValues" + }, + "description": "Object containing the values of the updated file data attributes and their values prior to the event." + } + ] + } + }, + "type_:FileCopy": { + "name": "FileCopy", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "datetime_removed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date and time when a file was removed, if any." + }, + { + "key": "datetime_stored", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date and time of the last store request, if any." + }, + { + "key": "datetime_uploaded", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when a file was uploaded." + }, + { + "key": "is_image", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Is file is image." + }, + { + "key": "is_ready", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Is file is ready to be used after upload." + }, + { + "key": "mime_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File MIME-type." + }, + { + "key": "original_file_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Publicly available file CDN URL. Available if a file is not deleted." + }, + { + "key": "original_filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Original file name taken from uploaded file." + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "File size in bytes." + }, + { + "key": "url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "API resource URL for a particular file." + }, + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + }, + { + "key": "variations", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "content_info", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Metadata" + } + } + } + ] + } + }, + "type_:File": { + "name": "File", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "datetime_removed", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date and time when a file was removed, if any." + }, + { + "key": "datetime_stored", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Date and time of the last store request, if any." + }, + { + "key": "datetime_uploaded", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when a file was uploaded." + }, + { + "key": "is_image", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Is file is image." + }, + { + "key": "is_ready", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Is file is ready to be used after upload." + }, + { + "key": "mime_type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File MIME-type." + }, + { + "key": "original_file_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Publicly available file CDN URL. Available if a file is not deleted." + }, + { + "key": "original_filename", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Original file name taken from uploaded file." + }, + { + "key": "size", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "File size in bytes." + }, + { + "key": "url", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "API resource URL for a particular file." + }, + { + "key": "uuid", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "File UUID." + }, + { + "key": "appdata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ApplicationDataObject" + } + } + }, + { + "key": "variations", + "valueShape": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + }, + "description": "Dictionary of other files that were created using this file as a source. It's used for video processing and document conversion jobs. E.g., `: `." + }, + { + "key": "content_info", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ContentInfo" + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:Metadata" + } + } + } + ] + } + }, + "type_:Metadata": { + "name": "Metadata", + "description": "Arbitrary metadata associated with a file.", + "shape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + } + } + } + }, + "type_:MetadataItemValue": { + "name": "MetadataItemValue", + "description": "Value of metadata key.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:ContentInfoMime": { + "name": "ContentInfoMime", + "description": "MIME type.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mime", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Full MIME type." + }, + { + "key": "type", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Type of MIME type." + }, + { + "key": "subtype", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Subtype of MIME type." + } + ] + } + }, + "type_:ContentInfo": { + "name": "ContentInfo", + "description": "Information about file content.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "mime", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ContentInfoMime" + } + }, + "description": "MIME type." + }, + { + "key": "image", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageInfo" + } + } + }, + { + "key": "video", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:VideoInfo" + } + } + } + ] + } + }, + "type_:ImageInfoColorMode": { + "name": "ImageInfoColorMode", + "description": "Image color mode.", + "shape": { + "type": "enum", + "values": [ + { + "value": "RGB" + }, + { + "value": "RGBA" + }, + { + "value": "RGBa" + }, + { + "value": "RGBX" + }, + { + "value": "L" + }, + { + "value": "LA" + }, + { + "value": "La" + }, + { + "value": "P" + }, + { + "value": "PA" + }, + { + "value": "CMYK" + }, + { + "value": "YCbCr" + }, + { + "value": "HSV" + }, + { + "value": "LAB" + } + ] + } + }, + "type_:ImageInfoGeoLocation": { + "name": "ImageInfoGeoLocation", + "description": "Geo-location of image from EXIF.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "latitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location latitude." + }, + { + "key": "longitude", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Location longitude." + } + ] + } + }, + "type_:ImageInfo": { + "name": "ImageInfo", + "description": "Image metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "color_mode", + "valueShape": { + "type": "id", + "id": "type_:ImageInfoColorMode" + }, + "description": "Image color mode." + }, + { + "key": "orientation", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Image orientation from EXIF." + }, + { + "key": "format", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Image format." + }, + { + "key": "sequence", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + }, + "description": "Set to true if a file contains a sequence of images (GIF for example)." + }, + { + "key": "height", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Image height in pixels." + }, + { + "key": "width", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Image width in pixels." + }, + { + "key": "geo_location", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:ImageInfoGeoLocation" + } + }, + "description": "Geo-location of image from EXIF." + }, + { + "key": "datetime_original", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "Image date and time from EXIF. Please be aware that this data is not always formatted and displayed exactly as it appears in the EXIF." + }, + { + "key": "dpi", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + "description": "Image DPI for two dimensions." + } + ] + } + }, + "type_:VideoInfoAudioItem": { + "name": "VideoInfoAudioItem", + "description": "Audio stream's metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Audio stream's bitrate." + }, + { + "key": "codec", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Audio stream's codec." + }, + { + "key": "sample_rate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Audio stream's sample rate." + }, + { + "key": "channels", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Audio stream's number of channels." + } + ] + } + }, + "type_:VideoInfoVideoItem": { + "name": "VideoInfoVideoItem", + "description": "Video stream's metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "height", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Video stream's image height." + }, + { + "key": "width", + "valueShape": { + "type": "primitive", + "value": { + "type": "integer" + } + }, + "description": "Video stream's image width." + }, + { + "key": "frame_rate", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + }, + "description": "Video stream's frame rate." + }, + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Video stream's bitrate." + }, + { + "key": "codec", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Video stream's codec." + } + ] + } + }, + "type_:VideoInfo": { + "name": "VideoInfo", + "description": "Video metadata.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "duration", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Video file's duration in milliseconds." + }, + { + "key": "format", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "Video file's format." + }, + { + "key": "bitrate", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Video file's bitrate." + }, + { + "key": "audio", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VideoInfoAudioItem" + } + } + }, + { + "key": "video", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:VideoInfoVideoItem" + } + } + } + ] + } + }, + "type_:CopiedFileUrl": { + "name": "CopiedFileUrl", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "URL with an s3 scheme. Your bucket name is put as a host, and an s3 object path follows." + } + ] + } + }, + "type_:Group": { + "name": "Group", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Group's identifier." + }, + { + "key": "datetime_created", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + }, + "description": "ISO-8601 date and time when the group was created." + }, + { + "key": "files_count", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of the files in the group." + }, + { + "key": "cdn_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Group's CDN URL." + }, + { + "key": "url", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Group's API resource URL." + } + ] + } + }, + "type_:GroupWithFiles": { + "name": "GroupWithFiles", + "shape": { + "type": "object", + "extends": [ + "type_:Group" + ], + "properties": [ + { + "key": "files", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "unknown" + } + } + }, + "description": "The list of files in the group. An array may contain null values if a file has been removed." + } + ] + } + }, + "type_:ProjectCollaboratorsItem": { + "name": "ProjectCollaboratorsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Collaborator email." + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Collaborator name." + } + ] + } + }, + "type_:Project": { + "name": "Project", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "collaborators", + "valueShape": { + "type": "optional", + "shape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:ProjectCollaboratorsItem" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Project login name." + }, + { + "key": "pub_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Project public key." + }, + { + "key": "autostore_enabled", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "type_:WebhookId": { + "name": "WebhookId", + "description": "Webhook's ID.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + "type_:WebhookProject": { + "name": "WebhookProject", + "description": "Project ID the webhook belongs to.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + "type_:WebhookProjectPubkey": { + "name": "WebhookProjectPubkey", + "description": "Public project key the webhook belongs to.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:WebhookCreated": { + "name": "WebhookCreated", + "description": "date-time when a webhook was created.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + "type_:WebhookUpdated": { + "name": "WebhookUpdated", + "description": "date-time when a webhook was updated.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + "type_:WebhookTarget": { + "name": "WebhookTarget", + "description": "A URL that is triggered by an event, for example, a file upload. A target URL MUST be unique for each `project` — `event type` combination.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:WebhookEvent": { + "name": "WebhookEvent", + "description": "An event you subscribe to.", + "shape": { + "type": "enum", + "values": [ + { + "value": "file.uploaded" + }, + { + "value": "file.infected" + }, + { + "value": "file.stored" + }, + { + "value": "file.deleted" + }, + { + "value": "file.info_updated" + } + ] + } + }, + "type_:WebhookIsActive": { + "name": "WebhookIsActive", + "description": "Marks a subscription as either active or not, defaults to `true`, otherwise `false`.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + "type_:WebhookSigningSecret": { + "name": "WebhookSigningSecret", + "description": "Optional [HMAC/SHA-256](https://en.wikipedia.org/wiki/HMAC) secret that, if set, will be used to\ncalculate signatures for the webhook payloads sent to the `target_url`.\n\nCalculated signature will be sent to the `target_url` as a value of the `X-Uc-Signature` HTTP\nheader. The header will have the following format: `X-Uc-Signature: v1=`.\nSee [Secure Webhooks](https://uploadcare.com/docs/webhooks/#signed-webhooks) for details.", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "type_:WebhookVersion": { + "name": "WebhookVersion", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "0.7" + } + } + } + }, + "type_:WebhookVersionOfRequest": { + "name": "WebhookVersionOfRequest", + "shape": { + "type": "alias", + "value": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "0.7" + } + } + } + }, + "type_:WebhookVersionOfListResponse": { + "name": "WebhookVersionOfListResponse", + "description": "Webhook payload's version.", + "shape": { + "type": "enum", + "values": [ + { + "value": "" + }, + { + "value": "0.5" + }, + { + "value": "0.6" + }, + { + "value": "0.7" + } + ] + } + }, + "type_:Webhook": { + "name": "Webhook", + "description": "Webhook.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookId" + } + } + }, + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookProject" + } + } + }, + { + "key": "created", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookCreated" + } + } + }, + { + "key": "updated", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookUpdated" + } + } + }, + { + "key": "event", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookEvent" + } + } + }, + { + "key": "target_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookTarget" + } + } + }, + { + "key": "is_active", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookIsActive" + } + } + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookVersion" + } + } + }, + { + "key": "signing_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookSigningSecret" + } + } + } + ] + } + }, + "type_:WebhookOfListResponse": { + "name": "WebhookOfListResponse", + "description": "Webhook.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookId" + } + } + }, + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookProject" + } + } + }, + { + "key": "created", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookCreated" + } + } + }, + { + "key": "updated", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookUpdated" + } + } + }, + { + "key": "event", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookEvent" + } + } + }, + { + "key": "target_url", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookTarget" + } + } + }, + { + "key": "is_active", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookIsActive" + } + } + }, + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookVersionOfListResponse" + } + } + }, + { + "key": "signing_secret", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookSigningSecret" + } + } + } + ] + } + }, + "type_:WebhookInitiatorType": { + "name": "WebhookInitiatorType", + "description": "Initiator type name.", + "shape": { + "type": "enum", + "values": [ + { + "value": "api" + }, + { + "value": "system" + }, + { + "value": "addon" + } + ] + } + }, + "type_:WebhookInitiatorDetailAddonName": { + "name": "WebhookInitiatorDetailAddonName", + "description": "Add-On name.", + "shape": { + "type": "enum", + "values": [ + { + "value": "aws_rekognition_detect_labels" + }, + { + "value": "aws_rekognition_detect_moderation_labels" + }, + { + "value": "uc_clamav_virus_scan" + }, + { + "value": "remove_bg" + }, + { + "value": "zamzar_convert_document" + }, + { + "value": "zencoder_convert_video" + } + ] + } + }, + "type_:WebhookInitiatorDetail": { + "name": "WebhookInitiatorDetail", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "request_id", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Request ID." + }, + { + "key": "addon_name", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookInitiatorDetailAddonName" + } + }, + "description": "Add-On name." + }, + { + "key": "source_file_uuid", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Source file UUID if the current is derivative." + } + ] + } + }, + "type_:WebhookInitiator": { + "name": "WebhookInitiator", + "description": "Webhook event initiator.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "id", + "id": "type_:WebhookInitiatorType" + }, + "description": "Initiator type name." + }, + { + "key": "detail", + "valueShape": { + "type": "id", + "id": "type_:WebhookInitiatorDetail" + } + } + ] + } + }, + "type_:WebhookPublicInfo": { + "name": "WebhookPublicInfo", + "description": "Public Webhook information (does not include secret data like `signing_secret`)", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "id", + "id": "type_:WebhookId" + } + }, + { + "key": "project", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookProject" + } + } + }, + { + "key": "project_pub_key", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:WebhookProjectPubkey" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "id", + "id": "type_:WebhookCreated" + } + }, + { + "key": "updated_at", + "valueShape": { + "type": "id", + "id": "type_:WebhookUpdated" + } + }, + { + "key": "event", + "valueShape": { + "type": "id", + "id": "type_:WebhookEvent" + } + }, + { + "key": "target", + "valueShape": { + "type": "id", + "id": "type_:WebhookTarget" + } + }, + { + "key": "is_active", + "valueShape": { + "type": "id", + "id": "type_:WebhookIsActive" + } + }, + { + "key": "version", + "valueShape": { + "type": "id", + "id": "type_:WebhookVersion" + } + } + ] + } + }, + "type_:CantUseDocsConversionError": { + "name": "CantUseDocsConversionError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:CantUseVideoConversionError": { + "name": "CantUseVideoConversionError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:CantUseWebhooksError": { + "name": "CantUseWebhooksError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:JsonObjectParseError": { + "name": "JsonObjectParseError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Expected JSON object." + } + ] + } + }, + "type_:LocalCopyResponse": { + "name": "LocalCopyResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "result", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:FileCopy" + } + } + } + ] + } + }, + "type_:ApplicationData": { + "name": "ApplicationData", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "description": "An application version." + }, + { + "key": "datetime_created", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was created." + }, + { + "key": "datetime_updated", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was updated." + }, + { + "key": "data", + "valueShape": { + "type": "map", + "keyShape": { + "type": "primitive", + "value": { + "type": "string" + } + }, + "valueShape": { + "type": "unknown" + } + }, + "description": "Dictionary with a result of an application execution result." + } + ] + } + }, + "type_:RemoveBgV10Data": { + "name": "RemoveBgV10Data", + "description": "Dictionary with a result of an remove.bg information about an image.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "foreground_type", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "foreground classification type (present if type_level was set)" + } + ] + } + }, + "type_:RemoveBgV10": { + "name": "RemoveBgV10", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "1.0" + } + } + } + }, + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RemoveBgV10Data" + } + }, + "description": "Dictionary with a result of an remove.bg information about an image." + }, + { + "key": "datetime_created", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was created." + }, + { + "key": "datetime_updated", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was updated." + } + ] + } + }, + "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox": { + "name": "AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "Height", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "Left", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "Top", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "Width", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem": { + "name": "AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "BoundingBox", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox" + } + } + }, + { + "key": "Confidence", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem": { + "name": "AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "Name", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem": { + "name": "AwsRekognitionDetectLabelsV20160627DataLabelsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "Confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Instances", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem" + } + } + }, + { + "key": "Name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "Parents", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem" + } + } + } + ] + } + }, + "type_:AwsRekognitionDetectLabelsV20160627Data": { + "name": "AwsRekognitionDetectLabelsV20160627Data", + "description": "Dictionary with a result of an aws rekognition detect labels execution result.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "LabelModelVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "Labels", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:AwsRekognitionDetectLabelsV20160627DataLabelsItem" + } + } + } + ] + } + }, + "type_:AwsRekognitionDetectLabelsV20160627": { + "name": "AwsRekognitionDetectLabelsV20160627", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "2016-06-27" + } + } + } + }, + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AwsRekognitionDetectLabelsV20160627Data" + } + }, + "description": "Dictionary with a result of an aws rekognition detect labels execution result." + }, + { + "key": "datetime_created", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was created." + }, + { + "key": "datetime_updated", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was updated." + } + ] + } + }, + "type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem": { + "name": "AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "Confidence", + "valueShape": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + { + "key": "Name", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "ParentName", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + }, + "type_:AwsRekognitionDetectModerationLabelsV20160627Data": { + "name": "AwsRekognitionDetectModerationLabelsV20160627Data", + "description": "Dictionary with a result of an aws rekognition detect moderation labels execution result.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ModerationModelVersion", + "valueShape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "ModerationLabels", + "valueShape": { + "type": "list", + "itemShape": { + "type": "id", + "id": "type_:AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem" + } + } + } + ] + } + }, + "type_:AwsRekognitionDetectModerationLabelsV20160627": { + "name": "AwsRekognitionDetectModerationLabelsV20160627", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "literal", + "value": { + "type": "stringLiteral", + "value": "2016-06-27" + } + } + } + }, + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AwsRekognitionDetectModerationLabelsV20160627Data" + } + }, + "description": "Dictionary with a result of an aws rekognition detect moderation labels execution result." + }, + { + "key": "datetime_created", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was created." + }, + { + "key": "datetime_updated", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was updated." + } + ] + } + }, + "type_:UcClamavVirusScanVersion": { + "name": "UcClamavVirusScanVersion", + "shape": { + "type": "enum", + "values": [ + { + "value": "0.104.2" + }, + { + "value": "0.104.3" + }, + { + "value": "0.105.0" + }, + { + "value": "0.105.1" + } + ] + } + }, + "type_:UcClamavVirusScanData": { + "name": "UcClamavVirusScanData", + "description": "Dictionary with a result of ClamAV execution result.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "infected", + "valueShape": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + { + "key": "infected_with", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:UcClamavVirusScan": { + "name": "UcClamavVirusScan", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "version", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UcClamavVirusScanVersion" + } + } + }, + { + "key": "data", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UcClamavVirusScanData" + } + }, + "description": "Dictionary with a result of ClamAV execution result." + }, + { + "key": "datetime_created", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was created." + }, + { + "key": "datetime_updated", + "valueShape": { + "type": "primitive", + "value": { + "type": "datetime" + } + }, + "description": "Date and time when an application data was updated." + } + ] + } + }, + "type_:ApplicationDataObject": { + "name": "ApplicationDataObject", + "description": "Dictionary of application names and data associated with these applications.", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "aws_rekognition_detect_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AwsRekognitionDetectLabelsV20160627" + } + } + }, + { + "key": "aws_rekognition_detect_moderation_labels", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:AwsRekognitionDetectModerationLabelsV20160627" + } + } + }, + { + "key": "remove_bg", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:RemoveBgV10" + } + } + }, + { + "key": "uc_clamav_virus_scan", + "valueShape": { + "type": "optional", + "shape": { + "type": "id", + "id": "type_:UcClamavVirusScan" + } + } + } + ] + } + }, + "type_:SimpleAuthHttpForbidden": { + "name": "SimpleAuthHttpForbidden", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "type_:WebhookTargetUrlError": { + "name": "WebhookTargetUrlError", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "detail", + "valueShape": { + "type": "optional", + "shape": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "`target_url` is missing." + } + ] + } + } + }, + "subpackages": { + "subpackage_file": { + "id": "subpackage_file", + "name": "File" + }, + "subpackage_addOns": { + "id": "subpackage_addOns", + "name": "Add-Ons" + }, + "subpackage_fileMetadata": { + "id": "subpackage_fileMetadata", + "name": "File metadata" + }, + "subpackage_group": { + "id": "subpackage_group", + "name": "Group" + }, + "subpackage_project": { + "id": "subpackage_project", + "name": "Project" + }, + "subpackage_webhook": { + "id": "subpackage_webhook", + "name": "Webhook" + }, + "subpackage_conversion": { + "id": "subpackage_conversion", + "name": "Conversion" + } + }, + "auths": { + "default": { + "type": "header", + "headerWireValue": "Authorization", + "nameOverride": "apiKey" + } + } + } +] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/node.json b/packages/fdr-sdk/src/__test__/output/uploadcare/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/node.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/uploadcare/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/uploadcare/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/pageIds.json b/packages/fdr-sdk/src/__test__/output/uploadcare/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/pageIds.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/sitemap.json b/packages/fdr-sdk/src/__test__/output/uploadcare/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/sitemap.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/uploadcare/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/uploadcare/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/uploadcare/slugs.json b/packages/fdr-sdk/src/__test__/output/uploadcare/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/uploadcare/slugs.json rename to packages/fdr-sdk/src/__test__/output/uploadcare/slugs.json diff --git a/packages/fdr-sdk/src/__test__/output/uploadcare/versionNodes.json b/packages/fdr-sdk/src/__test__/output/uploadcare/versionNodes.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/uploadcare/versionNodes.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/apiDefinitions.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/apiDefinitions.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/node.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/node.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/orphanedNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/orphanedNodesWithContent.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/orphanedNodesWithContent.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/pageIds.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/pageIds.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/sitemap.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/sitemap.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/slugs.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/slugs.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/versionNodes.json b/packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-no-tabs/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/yes-version-no-tabs/versionNodes.json diff --git a/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/apiDefinitions.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/apiDefinitions.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/apiDefinitions.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/node.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/node.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/node.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/node.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/orphanedNodes.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/orphanedNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/orphanedNodes.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/orphanedNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/orphanedNodesWithContent.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/orphanedNodesWithContent.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/orphanedNodesWithContent.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/orphanedNodesWithContent.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/pageIds.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/pageIds.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/pageIds.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/pageIds.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/sitemap.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/sitemap.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/slugs-pages.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/slugs-pages.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/slugs-pages.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/slugs-pages.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/slugs-sitemap.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/slugs-sitemap.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/slugs-sitemap.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/slugs-sitemap.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/slugs.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/slugs.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/slugs.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/slugs.json diff --git a/packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/versionNodes.json b/packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/versionNodes.json similarity index 100% rename from packages/fdr-sdk/src/navigation/__test__/output/yes-version-yes-tabs/versionNodes.json rename to packages/fdr-sdk/src/__test__/output/yes-version-yes-tabs/versionNodes.json diff --git a/packages/fdr-sdk/src/navigation/__test__/polytomic.test.ts b/packages/fdr-sdk/src/__test__/polytomic.test.ts similarity index 87% rename from packages/fdr-sdk/src/navigation/__test__/polytomic.test.ts rename to packages/fdr-sdk/src/__test__/polytomic.test.ts index 2e8c64b018..b9604f3669 100644 --- a/packages/fdr-sdk/src/navigation/__test__/polytomic.test.ts +++ b/packages/fdr-sdk/src/__test__/polytomic.test.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/navigation/__test__/primer.test.ts b/packages/fdr-sdk/src/__test__/primer.test.ts similarity index 86% rename from packages/fdr-sdk/src/navigation/__test__/primer.test.ts rename to packages/fdr-sdk/src/__test__/primer.test.ts index 1bd456a9e1..32a0d7078a 100644 --- a/packages/fdr-sdk/src/navigation/__test__/primer.test.ts +++ b/packages/fdr-sdk/src/__test__/primer.test.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/navigation/__test__/readFixtures.ts b/packages/fdr-sdk/src/__test__/readFixtures.ts similarity index 87% rename from packages/fdr-sdk/src/navigation/__test__/readFixtures.ts rename to packages/fdr-sdk/src/__test__/readFixtures.ts index 9719bedc43..33ff04e09a 100644 --- a/packages/fdr-sdk/src/navigation/__test__/readFixtures.ts +++ b/packages/fdr-sdk/src/__test__/readFixtures.ts @@ -1,6 +1,6 @@ import fs from "fs"; import path from "path"; -import { DocsV2Read } from "../../client"; +import { DocsV2Read } from "../client"; export function readFixture(fixture: string) { const fixturePath = path.join(__dirname, "fixtures", `${fixture}.json`); diff --git a/packages/fdr-sdk/src/navigation/__test__/testGetAllUrlsFromDocsConfig.ts b/packages/fdr-sdk/src/__test__/testGetAllUrlsFromDocsConfig.ts similarity index 79% rename from packages/fdr-sdk/src/navigation/__test__/testGetAllUrlsFromDocsConfig.ts rename to packages/fdr-sdk/src/__test__/testGetAllUrlsFromDocsConfig.ts index 2633f846dc..8359e695c7 100644 --- a/packages/fdr-sdk/src/navigation/__test__/testGetAllUrlsFromDocsConfig.ts +++ b/packages/fdr-sdk/src/__test__/testGetAllUrlsFromDocsConfig.ts @@ -1,6 +1,6 @@ import urljoin from "url-join"; -import { FernNavigation } from "../.."; -import { NodeCollector } from "../NodeCollector"; +import { FernNavigation } from ".."; +import { NodeCollector } from "../navigation/NodeCollector"; export function testGetAllUrlsFromDocsConfig(root: FernNavigation.RootNode, domain: string): void { it("gets all urls from docs config", async () => { diff --git a/packages/fdr-sdk/src/navigation/__test__/testGetNavigationRoot.ts b/packages/fdr-sdk/src/__test__/testGetNavigationRoot.ts similarity index 86% rename from packages/fdr-sdk/src/navigation/__test__/testGetNavigationRoot.ts rename to packages/fdr-sdk/src/__test__/testGetNavigationRoot.ts index 29475e9397..e1fa949ba2 100644 --- a/packages/fdr-sdk/src/navigation/__test__/testGetNavigationRoot.ts +++ b/packages/fdr-sdk/src/__test__/testGetNavigationRoot.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { findNode } from "../utils"; +import { FernNavigation } from ".."; +import { findNode } from "../navigation/utils"; export function testGetNavigationRoot(root: FernNavigation.RootNode, slug: string): void { it("gets navigation root for /" + slug, async () => { diff --git a/packages/fdr-sdk/src/navigation/__test__/uploadcare.test.ts b/packages/fdr-sdk/src/__test__/uploadcare.test.ts similarity index 87% rename from packages/fdr-sdk/src/navigation/__test__/uploadcare.test.ts rename to packages/fdr-sdk/src/__test__/uploadcare.test.ts index 273bb12e60..104c235bfd 100644 --- a/packages/fdr-sdk/src/navigation/__test__/uploadcare.test.ts +++ b/packages/fdr-sdk/src/__test__/uploadcare.test.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/navigation/__test__/yes-version-no-tabs.test.ts b/packages/fdr-sdk/src/__test__/yes-version-no-tabs.test.ts similarity index 88% rename from packages/fdr-sdk/src/navigation/__test__/yes-version-no-tabs.test.ts rename to packages/fdr-sdk/src/__test__/yes-version-no-tabs.test.ts index 3a75b7d8e2..f0d5a8b4f9 100644 --- a/packages/fdr-sdk/src/navigation/__test__/yes-version-no-tabs.test.ts +++ b/packages/fdr-sdk/src/__test__/yes-version-no-tabs.test.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/navigation/__test__/yes-version-yes-tabs.test.ts b/packages/fdr-sdk/src/__test__/yes-version-yes-tabs.test.ts similarity index 88% rename from packages/fdr-sdk/src/navigation/__test__/yes-version-yes-tabs.test.ts rename to packages/fdr-sdk/src/__test__/yes-version-yes-tabs.test.ts index eca58d6abf..35c5e75d03 100644 --- a/packages/fdr-sdk/src/navigation/__test__/yes-version-yes-tabs.test.ts +++ b/packages/fdr-sdk/src/__test__/yes-version-yes-tabs.test.ts @@ -1,5 +1,5 @@ -import { FernNavigation } from "../.."; -import { FernNavigationV1ToLatest } from "../migrators/v1ToV2"; +import { FernNavigation } from ".."; +import { FernNavigationV1ToLatest } from "../navigation/migrators/v1ToV2"; import { readFixture } from "./readFixtures"; import { testGetAllUrlsFromDocsConfig } from "./testGetAllUrlsFromDocsConfig"; import { testGetNavigationRoot } from "./testGetNavigationRoot"; diff --git a/packages/fdr-sdk/src/api-definition/__test__/availability.test.ts b/packages/fdr-sdk/src/api-definition/__test__/availability.test.ts new file mode 100644 index 0000000000..422e63ba0e --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/__test__/availability.test.ts @@ -0,0 +1,21 @@ +import { coalesceAvailability } from "../availability"; +import { Availability } from "../latest"; + +describe("coalesceAvailability", () => { + it("should return the least stable availability level", () => { + expect(coalesceAvailability([Availability.Stable, Availability.Beta])).toBe(Availability.Beta); + expect(coalesceAvailability([Availability.Beta, Availability.Stable])).toBe(Availability.Beta); + expect(coalesceAvailability([Availability.Stable, Availability.Beta, Availability.Deprecated])).toBe( + Availability.Deprecated, + ); + expect(coalesceAvailability([Availability.Beta, Availability.InDevelopment])).toBe(Availability.InDevelopment); + expect(coalesceAvailability([Availability.PreRelease, Availability.InDevelopment])).toBe( + Availability.InDevelopment, + ); + expect(coalesceAvailability([Availability.GenerallyAvailable])).toBe(Availability.GenerallyAvailable); + expect(coalesceAvailability([Availability.Stable, Availability.Beta, Availability.Stable])).toBe( + Availability.Beta, + ); + expect(coalesceAvailability([])).toBeUndefined(); + }); +}); diff --git a/packages/fdr-sdk/src/api-definition/__test__/join.test.ts b/packages/fdr-sdk/src/api-definition/__test__/join.test.ts new file mode 100644 index 0000000000..845ec4d4c2 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/__test__/join.test.ts @@ -0,0 +1,282 @@ +import { APIV1Read } from "../../client"; +import { join } from "../join"; +import * as Latest from "../latest"; + +const PRIMITIVE_SHAPE: Latest.TypeReference.Primitive = { + type: "primitive" as const, + value: { + type: "string", + regex: undefined, + minLength: undefined, + maxLength: undefined, + default: undefined, + }, +}; + +const endpoint1: Latest.EndpointDefinition = { + id: Latest.EndpointId("endpoint-1"), + namespace: [], + method: "GET", + path: [], + defaultEnvironment: Latest.EnvironmentId("production"), + environments: [ + { + id: Latest.EnvironmentId("production"), + baseUrl: "https://example.com", + }, + ], + pathParameters: undefined, + queryParameters: [ + { + key: Latest.PropertyKey("query"), + valueShape: { + type: "id", + id: Latest.TypeId("type-1"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], + requestHeaders: undefined, + responseHeaders: undefined, + request: undefined, + response: undefined, + auth: undefined, + description: undefined, + availability: undefined, + errors: undefined, + examples: undefined, + snippetTemplates: undefined, +}; + +const endpoint2: Latest.EndpointDefinition = { + id: Latest.EndpointId("endpoint-2"), + namespace: [], + method: "GET", + path: [], + defaultEnvironment: Latest.EnvironmentId("production"), + environments: [ + { + id: Latest.EnvironmentId("production"), + baseUrl: "https://example.com", + }, + ], + pathParameters: undefined, + queryParameters: undefined, + requestHeaders: [ + { + key: Latest.PropertyKey("header"), + valueShape: { + type: "id", + id: Latest.TypeId("type-2"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], + responseHeaders: undefined, + request: undefined, + response: undefined, + auth: [Latest.AuthSchemeId("auth")], + description: undefined, + availability: undefined, + errors: undefined, + examples: undefined, + snippetTemplates: undefined, +}; + +const websocket1: Latest.WebSocketChannel = { + id: Latest.WebSocketId("websocket-1"), + namespace: [], + path: [], + messages: [ + { + type: APIV1Read.WebSocketMessageId("message-1"), + description: undefined, + availability: undefined, + displayName: undefined, + origin: "client", + body: { + type: "alias", + value: { + type: "optional", + default: undefined, + shape: { + type: "id", + id: Latest.TypeId("type-3"), + default: undefined, + }, + }, + }, + }, + ], + defaultEnvironment: Latest.EnvironmentId("production"), + environments: [ + { + id: Latest.EnvironmentId("production"), + baseUrl: "https://example.com", + }, + ], + pathParameters: undefined, + queryParameters: undefined, + requestHeaders: undefined, + auth: undefined, + description: undefined, + availability: undefined, + examples: undefined, +}; + +const type1: Latest.TypeDefinition = { + name: "type-1", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const type2: Latest.TypeDefinition = { + name: "type-2", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const type3: Latest.TypeDefinition = { + name: "type-3", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const type4: Latest.TypeDefinition = { + name: "type-4", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const authScheme: Latest.AuthScheme = { + type: "bearerAuth", + tokenName: "API Token", +}; + +const api1: Latest.ApiDefinition = { + id: Latest.ApiDefinitionId("api"), + endpoints: { + [endpoint1.id]: endpoint1, + }, + webhooks: {}, + websockets: {}, + types: { + [Latest.TypeId("type-1")]: type1, + [Latest.TypeId("type-4")]: type4, + }, + subpackages: {}, + auths: {}, + globalHeaders: [ + { + key: Latest.PropertyKey("global"), + valueShape: { + type: "id", + id: Latest.TypeId("type-4"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], +}; + +const api2: Latest.ApiDefinition = { + id: Latest.ApiDefinitionId("api"), + endpoints: { + [endpoint2.id]: endpoint2, + }, + webhooks: {}, + websockets: {}, + types: { + [Latest.TypeId("type-2")]: type2, + [Latest.TypeId("type-4")]: type4, + }, + subpackages: {}, + auths: { + [Latest.AuthSchemeId("auth")]: authScheme, + }, + globalHeaders: [ + { + key: Latest.PropertyKey("global"), + valueShape: { + type: "id", + id: Latest.TypeId("type-4"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], +}; + +const api3: Latest.ApiDefinition = { + id: Latest.ApiDefinitionId("api"), + endpoints: {}, + webhooks: {}, + websockets: { + [websocket1.id]: websocket1, + }, + types: { + [Latest.TypeId("type-3")]: type3, + [Latest.TypeId("type-4")]: type4, + }, + subpackages: {}, + auths: {}, + globalHeaders: [ + { + key: Latest.PropertyKey("global"), + valueShape: { + type: "id", + id: Latest.TypeId("type-4"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], +}; + +describe("join", () => { + it("should prune endpoint1 and its types", () => { + const pruned = join(api1, api2, api3); + + expect(Object.keys(pruned.endpoints)).toStrictEqual([endpoint1.id, endpoint2.id]); + expect(Object.keys(pruned.websockets)).toStrictEqual([websocket1.id]); + expect(new Set(Object.keys(pruned.types))).toStrictEqual( + new Set([type1.name, type2.name, type3.name, type4.name]), + ); + expect(Object.keys(pruned.auths)).toStrictEqual([Latest.AuthSchemeId("auth")]); + expect(pruned.globalHeaders).toStrictEqual([ + { + key: Latest.PropertyKey("global"), + valueShape: { + type: "id", + id: Latest.TypeId("type-4"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ]); + }); +}); diff --git a/packages/fdr-sdk/src/api-definition/__test__/prune.test.ts b/packages/fdr-sdk/src/api-definition/__test__/prune.test.ts new file mode 100644 index 0000000000..44a289210b --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/__test__/prune.test.ts @@ -0,0 +1,244 @@ +import { APIV1Read } from "../../client"; +import * as Latest from "../latest"; +import { prune } from "../prune"; + +const PRIMITIVE_SHAPE: Latest.TypeReference.Primitive = { + type: "primitive" as const, + value: { + type: "string", + regex: undefined, + minLength: undefined, + maxLength: undefined, + default: undefined, + }, +}; + +const endpoint1: Latest.EndpointDefinition = { + id: Latest.EndpointId("endpoint-1"), + namespace: [], + method: "GET", + path: [], + defaultEnvironment: Latest.EnvironmentId("production"), + environments: [ + { + id: Latest.EnvironmentId("production"), + baseUrl: "https://example.com", + }, + ], + pathParameters: undefined, + queryParameters: [ + { + key: Latest.PropertyKey("query"), + valueShape: { + type: "id", + id: Latest.TypeId("type-1"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], + requestHeaders: undefined, + responseHeaders: undefined, + request: undefined, + response: undefined, + auth: undefined, + description: undefined, + availability: undefined, + errors: undefined, + examples: undefined, + snippetTemplates: undefined, +}; + +const endpoint2: Latest.EndpointDefinition = { + id: Latest.EndpointId("endpoint-2"), + namespace: [], + method: "GET", + path: [], + defaultEnvironment: Latest.EnvironmentId("production"), + environments: [ + { + id: Latest.EnvironmentId("production"), + baseUrl: "https://example.com", + }, + ], + pathParameters: undefined, + queryParameters: undefined, + requestHeaders: [ + { + key: Latest.PropertyKey("header"), + valueShape: { + type: "id", + id: Latest.TypeId("type-2"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], + responseHeaders: undefined, + request: undefined, + response: undefined, + auth: [Latest.AuthSchemeId("auth")], + description: undefined, + availability: undefined, + errors: undefined, + examples: undefined, + snippetTemplates: undefined, +}; + +const websocket1: Latest.WebSocketChannel = { + id: Latest.WebSocketId("websocket-1"), + namespace: [], + path: [], + messages: [ + { + type: APIV1Read.WebSocketMessageId("message-1"), + description: undefined, + availability: undefined, + displayName: undefined, + origin: "client", + body: { + type: "alias", + value: { + type: "optional", + default: undefined, + shape: { + type: "id", + id: Latest.TypeId("type-3"), + default: undefined, + }, + }, + }, + }, + ], + defaultEnvironment: Latest.EnvironmentId("production"), + environments: [ + { + id: Latest.EnvironmentId("production"), + baseUrl: "https://example.com", + }, + ], + pathParameters: undefined, + queryParameters: undefined, + requestHeaders: undefined, + auth: undefined, + description: undefined, + availability: undefined, + examples: undefined, +}; + +const type1: Latest.TypeDefinition = { + name: "type-1", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const type2: Latest.TypeDefinition = { + name: "type-2", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const type3: Latest.TypeDefinition = { + name: "type-3", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const type4: Latest.TypeDefinition = { + name: "type-4", + description: undefined, + availability: undefined, + shape: { + type: "alias", + value: PRIMITIVE_SHAPE, + }, +}; + +const authScheme: Latest.AuthScheme = { + type: "bearerAuth", + tokenName: "API Token", +}; + +const api: Latest.ApiDefinition = { + id: Latest.ApiDefinitionId("api"), + endpoints: { + [endpoint1.id]: endpoint1, + [endpoint2.id]: endpoint2, + }, + webhooks: {}, + websockets: { + [websocket1.id]: websocket1, + }, + types: { + [Latest.TypeId("type-1")]: type1, + [Latest.TypeId("type-2")]: type2, + [Latest.TypeId("type-3")]: type3, + [Latest.TypeId("type-4")]: type4, + }, + subpackages: {}, + auths: { + [Latest.AuthSchemeId("auth")]: authScheme, + }, + globalHeaders: [ + { + key: Latest.PropertyKey("global"), + valueShape: { + type: "id", + id: Latest.TypeId("type-4"), + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], +}; + +describe("prune", () => { + it("should prune endpoint1 and its types", () => { + const pruned = prune(api, { + type: "endpoint", + endpointId: endpoint1.id, + }); + + expect(Object.keys(pruned.endpoints)).toStrictEqual([endpoint1.id]); + expect(Object.keys(pruned.websockets)).toStrictEqual([]); + expect(Object.keys(pruned.types)).toStrictEqual([type1.name, type4.name]); + expect(Object.keys(pruned.auths)).toStrictEqual([]); + }); + + it("should prune endpoint2 and its types", () => { + const pruned = prune(api, { + type: "endpoint", + endpointId: endpoint2.id, + }); + expect(Object.keys(pruned.endpoints)).toStrictEqual([endpoint2.id]); + expect(Object.keys(pruned.websockets)).toStrictEqual([]); + expect(Object.keys(pruned.types)).toStrictEqual([type2.name, type4.name]); + expect(Object.keys(pruned.auths)).toStrictEqual(["auth"]); + }); + + it("should prune websocket1 and its types", () => { + const pruned = prune(api, { + type: "webSocket", + webSocketId: websocket1.id, + }); + expect(Object.keys(pruned.endpoints)).toStrictEqual([]); + expect(Object.keys(pruned.websockets)).toStrictEqual([websocket1.id]); + expect(Object.keys(pruned.types)).toStrictEqual([type3.name, type4.name]); + expect(Object.keys(pruned.auths)).toStrictEqual([]); + }); +}); diff --git a/packages/fdr-sdk/src/api-definition/__test__/unwrap.test.ts b/packages/fdr-sdk/src/api-definition/__test__/unwrap.test.ts new file mode 100644 index 0000000000..458e95031a --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/__test__/unwrap.test.ts @@ -0,0 +1,467 @@ +import { PropertyKey, TypeDefinition, TypeId, TypeReference } from "../latest"; +import { TypeShapeOrReference } from "../types"; +import { unwrapObjectType, unwrapReference } from "../unwrap"; + +const PRIMITIVE_SHAPE: TypeShapeOrReference = { + type: "primitive" as const, + value: { + type: "string", + regex: undefined, + minLength: undefined, + maxLength: undefined, + default: undefined, + }, +}; + +describe("unwrapReference", () => { + it("should noop for a non-reference", () => { + expect(unwrapReference(PRIMITIVE_SHAPE, {})).toStrictEqual({ + shape: PRIMITIVE_SHAPE, + availability: undefined, + descriptions: [], + isOptional: false, + default: undefined, + }); + }); + + it("should unwrap a reference", () => { + const shape: TypeShapeOrReference = { + type: "id", + id: TypeId("foo"), + default: undefined, + }; + const types: Record = { + [TypeId("foo")]: { + name: "foo", + shape: { type: "alias", value: PRIMITIVE_SHAPE }, + description: undefined, + availability: undefined, + }, + }; + expect(unwrapReference(shape, types)).toStrictEqual({ + shape: PRIMITIVE_SHAPE, + availability: undefined, + descriptions: [], + isOptional: false, + default: undefined, + }); + }); + + it("should unwrap to unknown", () => { + const shape: TypeShapeOrReference = { + type: "id", + id: TypeId("foo"), + default: undefined, + }; + expect(unwrapReference(shape, {})).toStrictEqual({ + shape: { + type: "unknown", + displayName: undefined, + }, + availability: undefined, + descriptions: [], + isOptional: false, + default: undefined, + }); + }); + + it("should unwrap optionals", () => { + const shape: TypeShapeOrReference = { + type: "id", + id: TypeId("foo"), + default: undefined, + }; + const types: Record = { + [TypeId("foo")]: { + name: "foo", + shape: { + type: "alias", + value: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: undefined, + }, + }, + description: undefined, + availability: undefined, + }, + }; + expect(unwrapReference(shape, types)).toStrictEqual({ + shape: PRIMITIVE_SHAPE, + availability: undefined, + descriptions: [], + isOptional: true, + default: undefined, + }); + }); + + it("should unwrap optionals with defaults", () => { + const shape: TypeShapeOrReference = { + type: "id", + id: TypeId("foo"), + default: undefined, + }; + const types: Record = { + [TypeId("foo")]: { + name: "foo", + shape: { + type: "alias", + value: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: "testing-a", + }, + }, + description: undefined, + availability: undefined, + }, + }; + expect(unwrapReference(shape, types).default).toBe("testing-a"); + }); + + it("should prefer shallowest default value", () => { + const shape: TypeShapeOrReference = { + type: "optional", + shape: { + type: "id", + id: TypeId("foo"), + default: undefined, + }, + default: "testing-b", + }; + const types: Record = { + [TypeId("foo")]: { + name: "foo", + shape: { + type: "alias", + value: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: "testing-a", // this should be ignored + }, + }, + description: undefined, + availability: undefined, + }, + }; + expect(unwrapReference(shape, types).default).toBe("testing-b"); + }); + + it("should return unknown on infinite circular reference", () => { + const shape: TypeReference = { + type: "id", + id: TypeId("foo"), + default: undefined, + }; + const types: Record = { + [TypeId("foo")]: { + name: "foo", + shape: { type: "alias", value: shape }, + description: undefined, + availability: undefined, + }, + }; + expect(unwrapReference(shape, types).shape.type).toBe("unknown"); + }); + + it("should return the least stable availability level, and collect all descriptions", () => { + const shape: TypeShapeOrReference = { + type: "id", + id: TypeId("a"), + default: undefined, + }; + const types: Record = { + [TypeId("a")]: { + name: "a", + shape: { + type: "alias", + value: { type: "id", id: TypeId("b"), default: undefined }, + }, + description: "a", + availability: "Stable", + }, + [TypeId("b")]: { + name: "b", + shape: { + type: "alias", + value: { + type: "optional", + shape: { type: "id", id: TypeId("c"), default: undefined }, + default: undefined, + }, + }, + description: "b", + availability: "Deprecated", + }, + [TypeId("c")]: { + name: "c", + shape: { type: "alias", value: PRIMITIVE_SHAPE }, + description: "c", + availability: "InDevelopment", + }, + }; + const unwrapped = unwrapReference(shape, types); + expect(unwrapped.shape).toStrictEqual(PRIMITIVE_SHAPE); + expect(unwrapped.availability).toBe("Deprecated"); + expect(unwrapped.descriptions).toStrictEqual(["a", "b", "c"]); + expect(unwrapped.isOptional).toBe(true); + }); + + it("should unwrap default value of enums", () => { + const types: Record = { + [TypeId("a")]: { + name: "a", + shape: { + type: "enum", + values: [ + { value: "a", description: undefined, availability: undefined }, + { value: "b", description: undefined, availability: undefined }, + ], + default: "a", + }, + description: undefined, + availability: undefined, + }, + }; + + expect( + unwrapReference( + { + type: "id", + id: TypeId("a"), + default: undefined, + }, + types, + ).default, + ).toBe("a"); + + expect( + unwrapReference( + { + type: "id", + id: TypeId("a"), + // this default overrides the default set by the enum: + default: { + type: "enum", + value: "b", + }, + }, + types, + ).default, + ).toBe("b"); + }); +}); + +describe("unwrapObjectType", () => { + it("should unwrap and sort required before optionals, and preserve order otherwise", () => { + const shape: TypeShapeOrReference = { + type: "object", + extends: [], + properties: [ + { + key: PropertyKey("d"), + valueShape: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: undefined, + }, + description: undefined, + availability: undefined, + }, + { + key: PropertyKey("a"), + valueShape: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: undefined, + }, + description: undefined, + availability: undefined, + }, + { + key: PropertyKey("c"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + { + key: PropertyKey("b"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + ], + }; + + expect(unwrapObjectType(shape, {}).properties.map((p) => p.key)).toStrictEqual([ + PropertyKey("c"), + PropertyKey("b"), + PropertyKey("d"), + PropertyKey("a"), + ]); + }); + + it("should unwrap extended objects", () => { + const shape: TypeShapeOrReference = { + type: "object", + extends: [TypeId("c"), TypeId("b")], + properties: [ + { + key: PropertyKey("a"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + { + key: PropertyKey("d"), + valueShape: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: undefined, + }, + description: undefined, + availability: undefined, + }, + ], + }; + const types: Record = { + [TypeId("b")]: { + name: "b", + shape: { + type: "object", + extends: [], + properties: [ + { + key: PropertyKey("b"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + ], + }, + description: undefined, + availability: undefined, + }, + [TypeId("c")]: { + name: "c", + shape: { + type: "object", + extends: [], + properties: [ + { + key: PropertyKey("c"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + ], + }, + description: undefined, + availability: undefined, + }, + }; + expect(unwrapObjectType(shape, types).properties.map((p) => p.key)).toStrictEqual([ + PropertyKey("a"), + PropertyKey("b"), + PropertyKey("c"), + PropertyKey("d"), + ]); + }); + + it("should mark properties of optional extended objects as optional", () => { + const shape: TypeShapeOrReference = { + type: "object", + extends: [TypeId("b")], + properties: [ + { + key: PropertyKey("a"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + ], + }; + const types: Record = { + [TypeId("b")]: { + name: "b", + shape: { + type: "alias", + value: { + type: "optional", + shape: { + type: "id", + id: TypeId("c"), + default: undefined, + }, + default: undefined, + }, + }, + description: "description-1", + availability: "GenerallyAvailable", + }, + [TypeId("c")]: { + name: "b", + shape: { + type: "object", + extends: [], + properties: [ + { + key: PropertyKey("b"), + valueShape: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: undefined, + }, + description: undefined, + availability: "Deprecated", + }, + { + key: PropertyKey("c"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + ], + }, + description: "description-2", + availability: undefined, + }, + }; + + const unwrapped = unwrapObjectType(shape, types); + + expect(unwrapped.properties).toStrictEqual([ + { + key: PropertyKey("a"), + valueShape: PRIMITIVE_SHAPE, + description: undefined, + availability: undefined, + }, + { + key: PropertyKey("c"), + valueShape: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: undefined, + }, + description: undefined, + // availability is the least stable of the extended object + availability: "GenerallyAvailable", + }, + { + key: PropertyKey("b"), + valueShape: { + type: "optional", + shape: PRIMITIVE_SHAPE, + default: undefined, + }, + description: undefined, + // availability is the least stable of the extended object + // and Deprecated is sorted after GenerallyAvailable + availability: "Deprecated", + }, + ]); + + expect(unwrapped.descriptions).toStrictEqual(["description-1", "description-2"]); + }); +}); diff --git a/packages/fdr-sdk/src/api-definition/availability.ts b/packages/fdr-sdk/src/api-definition/availability.ts new file mode 100644 index 0000000000..681143b254 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/availability.ts @@ -0,0 +1,38 @@ +import * as Latest from "./latest"; + +/** + * The order of availability levels, from most stable to least stable. + * + * This is used to sort the availability levels in the UI, and to determine the stability level of a type reference when multiple are available. + */ +export const AvailabilityOrder = [ + Latest.Availability.Stable, + Latest.Availability.GenerallyAvailable, + Latest.Availability.Beta, + Latest.Availability.PreRelease, + Latest.Availability.InDevelopment, + Latest.Availability.Deprecated, +] as const; + +/** + * @param availabilities an array of availability levels + * @returns the **least** stable availability level from the input array + */ +export function coalesceAvailability(availabilities: Latest.Availability[]): Latest.Availability | undefined { + for (const availability of [...AvailabilityOrder].reverse()) { + if (availabilities.includes(availability)) { + return availability; + } + } + return undefined; +} + +// the following code is used to check that the contents of the AvailabilityOrder array contains all the values of the Availability enum +type AvailabilityValues = (typeof Latest.Availability)[keyof typeof Latest.Availability]; +type CheckAvailabilityOrder = T[number] extends AvailabilityValues + ? AvailabilityValues extends T[number] + ? true + : false + : false; +type Assert = T; +export type CheckAssert = Assert>; diff --git a/packages/fdr-sdk/src/api-definition/const.ts b/packages/fdr-sdk/src/api-definition/const.ts new file mode 100644 index 0000000000..0907902c72 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/const.ts @@ -0,0 +1,5 @@ +/** + * The maximum number of times to loop while unwrapping a type reference. + * This may need to be increased if the API definition contains extremely deeply nested type references. + */ +export const LOOP_TOLERANCE = 100; diff --git a/packages/fdr-sdk/src/api-definition/index.ts b/packages/fdr-sdk/src/api-definition/index.ts index f6176f3990..57639830d1 100644 --- a/packages/fdr-sdk/src/api-definition/index.ts +++ b/packages/fdr-sdk/src/api-definition/index.ts @@ -1 +1,8 @@ -export * from "../client/generated/api/resources/api/resources/latest"; +export * from "./join"; +export * from "./latest"; +export * from "./migrators/v1ToV2"; +export * from "./prune"; +export * from "./snippets/curl"; +export * from "./transformer"; +export * from "./types"; +export * from "./unwrap"; diff --git a/packages/fdr-sdk/src/api-definition/join.ts b/packages/fdr-sdk/src/api-definition/join.ts new file mode 100644 index 0000000000..1ee5fe08ff --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/join.ts @@ -0,0 +1,61 @@ +import * as Latest from "./latest"; + +/** + * This utility is designed to join multiple API definitions into a single API definition. + * After pruning the API definitions server-side to only include the desired endpoints, websockets, and webhooks, + * this utility can be used to join the pruned API definitions back together on the client-side. + * + * @param apis list of API definitions to join (must have the same ID) + * @returns a new API definition that is the result of joining the input API definitions + */ +export function join(...apis: Latest.ApiDefinition[]): Latest.ApiDefinition { + const joined: Latest.ApiDefinition = { + id: apis[0]?.id ?? Latest.ApiDefinitionId(""), + endpoints: {}, + websockets: {}, + webhooks: {}, + types: {}, + subpackages: {}, + auths: {}, + globalHeaders: undefined, + }; + + for (const api of apis) { + if (api.id !== joined.id) { + throw new Error("Cannot join API definitions with different IDs"); + } + + for (const [endpointId, endpoint] of Object.entries(api.endpoints)) { + joined.endpoints[Latest.EndpointId(endpointId)] = endpoint; + } + + for (const [webSocketId, webSocket] of Object.entries(api.websockets)) { + joined.websockets[Latest.WebSocketId(webSocketId)] = webSocket; + } + + for (const [webhookId, webhook] of Object.entries(api.webhooks)) { + joined.webhooks[Latest.WebhookId(webhookId)] = webhook; + } + + for (const [typeId, type] of Object.entries(api.types)) { + joined.types[Latest.TypeId(typeId)] = type; + } + + for (const [subpackageId, subpackage] of Object.entries(api.subpackages)) { + joined.subpackages[Latest.SubpackageId(subpackageId)] = subpackage; + } + + for (const [authId, auth] of Object.entries(api.auths)) { + joined.auths[Latest.AuthSchemeId(authId)] = auth; + } + + const globalHeaders = (joined.globalHeaders ??= []); + api.globalHeaders?.forEach((header) => { + if (!globalHeaders.find((h) => h.key === header.key)) { + globalHeaders.push(header); + } + }); + } + + return joined; +} diff --git a/packages/fdr-sdk/src/api-definition/latest.ts b/packages/fdr-sdk/src/api-definition/latest.ts new file mode 100644 index 0000000000..09f36dca51 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/latest.ts @@ -0,0 +1,3 @@ +export * from "../client/generated/api/resources/api/resources/latest"; +export { SubpackageId } from "../client/generated/api/resources/api/resources/v1/resources/commons"; +export * from "../client/generated/api/resources/commons"; diff --git a/packages/fdr-sdk/src/api-definition/migrators/v1ToV2.ts b/packages/fdr-sdk/src/api-definition/migrators/v1ToV2.ts new file mode 100644 index 0000000000..2a58a12e9c --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/migrators/v1ToV2.ts @@ -0,0 +1,695 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; +import mapValues from "lodash-es/mapValues"; +import { APIV1Read } from "../../client"; +import { SupportedLanguage } from "../../client/generated/api/resources/api/resources/v1/resources/read/resources/endpoint/types/SupportedLanguage"; +import { ROOT_PACKAGE_ID } from "../../navigation/consts"; +import { LOOP_TOLERANCE } from "../const"; +import * as V2 from "../latest"; +import { convertToCurl } from "../snippets/curl"; +import { toHttpRequest } from "../snippets/HttpRequest"; +import { sortKeysByShape } from "../sort-keys"; + +interface Flags { + /** + * If true, rename the language "typescript" to "javascript" in the code snippets. + * This works for now because the TypeScript SDK snippets don't use TypeScript-specific features. + * But if they do in the future, we'll need to generate separate TypeScript and JavaScript snippets. + */ + useJavaScriptAsTypeScript: boolean; + + /** + * If true, avoid generating Typescript SDK snippets. + * In @fern-ui/ui's resolver, we generate http-snippets for JavaScript. + */ + alwaysEnableJavaScriptFetch: boolean; + + /** + * If true, the generated form data snippet will always include the `application/json` content type. + */ + usesApplicationJsonInFormDataValue: boolean; +} + +function isSubpackage(package_: APIV1Read.ApiDefinitionPackage): package_ is APIV1Read.ApiDefinitionSubpackage { + return typeof (package_ as APIV1Read.ApiDefinitionSubpackage).subpackageId === "string"; +} + +const AUTH_SCHEME_ID = V2.AuthSchemeId("default"); + +export class ApiDefinitionV1ToLatest { + static from(v1: APIV1Read.ApiDefinition, flags: Flags): ApiDefinitionV1ToLatest { + return new ApiDefinitionV1ToLatest(v1, flags); + } + + private auth: APIV1Read.ApiAuth | undefined; + private constructor( + private readonly v1: APIV1Read.ApiDefinition, + private readonly flags: Flags, + ) { + this.auth = v1.auth; + } + + static createEndpointId( + endpoint: APIV1Read.EndpointDefinition, + subpackageId: string = ROOT_PACKAGE_ID, + ): V2.EndpointId { + return V2.EndpointId(endpoint.originalEndpointId ?? `${subpackageId}.${endpoint.id}`); + } + + static createWebSocketId( + webSocket: APIV1Read.WebSocketChannel, + subpackageId: string = ROOT_PACKAGE_ID, + ): V2.WebSocketId { + return V2.WebSocketId(`${subpackageId}.${webSocket.id}`); + } + + static createWebhookId(webhook: APIV1Read.WebhookDefinition, subpackageId: string = ROOT_PACKAGE_ID): V2.WebhookId { + return V2.WebhookId(`${subpackageId}.${webhook.id}`); + } + + private endpoints: Record = {}; + private websockets: Record = {}; + private webhooks: Record = {}; + private subpackages: Record = {}; + private types: Record = {}; + public migrate = (): V2.ApiDefinition => { + Object.entries(this.v1.types).forEach(([id, type]) => { + this.types[V2.TypeId(id)] = { + name: type.name, + description: type.description, + availability: type.availability, + shape: this.migrateTypeShape(type.shape), + }; + }); + + [this.v1.rootPackage, ...Object.values(this.v1.subpackages)].forEach((pkg) => { + const [subpackageId, namespace] = this.collectNamespace(pkg, this.v1.subpackages); + pkg.endpoints.forEach((endpoint) => { + const id = ApiDefinitionV1ToLatest.createEndpointId(endpoint, subpackageId); + this.endpoints[id] = this.migrateEndpoint(id, endpoint, namespace); + }); + pkg.websockets.forEach((webSocket) => { + const id = ApiDefinitionV1ToLatest.createWebSocketId(webSocket, subpackageId); + this.websockets[id] = this.migrateWebSocket(id, webSocket, namespace); + }); + pkg.webhooks.forEach((webhook) => { + const id = ApiDefinitionV1ToLatest.createWebhookId(webhook, subpackageId); + this.webhooks[id] = this.migrateWebhook(id, webhook, namespace); + }); + }); + + Object.values(this.v1.subpackages).forEach((subpackage) => { + this.subpackages[subpackage.subpackageId] = this.migrateSubpackage(subpackage); + }); + + return { + id: this.v1.id, + endpoints: this.endpoints, + websockets: this.websockets, + webhooks: this.webhooks, + types: this.types, + subpackages: this.subpackages, + auths: this.v1.auth ? { [AUTH_SCHEME_ID]: this.v1.auth } : {}, + globalHeaders: this.migrateParameters(this.v1.globalHeaders), + }; + }; + + collectNamespace = ( + pkg: APIV1Read.ApiDefinitionPackage, + subpackages: Record, + ): [string, V2.SubpackageId[]] => { + if (!isSubpackage(pkg)) { + return [ROOT_PACKAGE_ID, []]; + } + const namespace: V2.SubpackageId[] = [pkg.subpackageId]; + + let subpackage = pkg; + let loop = 0; + while (subpackage.parent != null) { + if (loop > LOOP_TOLERANCE) { + throw new Error("Circular subpackage reference detected"); + } + + const next = subpackages[subpackage.parent]; + if (next == null) { + break; + } + namespace.unshift(subpackage.parent); + subpackage = next; + loop++; + } + + return [pkg.subpackageId, namespace]; + }; + + migrateEndpoint = ( + id: V2.EndpointId, + v1: APIV1Read.EndpointDefinition, + namespace: V2.SubpackageId[], + ): V2.EndpointDefinition => { + const toRet: V2.EndpointDefinition = { + id, + namespace, + description: v1.description, + availability: v1.availability, + method: v1.method, + path: v1.path.parts.filter((part) => part.value !== ""), + auth: v1.authed ? [AUTH_SCHEME_ID] : undefined, + defaultEnvironment: v1.defaultEnvironment, + environments: v1.environments, + pathParameters: this.migrateParameters(v1.path.pathParameters), + queryParameters: this.migrateParameters(v1.queryParameters), + requestHeaders: this.migrateParameters(v1.headers), + responseHeaders: undefined, + request: this.migrateHttpRequest(v1.request), + response: this.migrateHttpResponse(v1.response), + errors: this.migrateHttpErrors(v1.errorsV2), + examples: undefined, + snippetTemplates: v1.snippetTemplates, + }; + + toRet.examples = this.migrateHttpExamples(v1.examples, toRet); + + return toRet; + }; + + migrateWebSocket = ( + id: V2.WebSocketId, + v1: APIV1Read.WebSocketChannel, + namespace: V2.SubpackageId[], + ): V2.WebSocketChannel => { + const messages = this.migrateChannelMessages(v1.messages); + return { + id, + namespace, + description: v1.description, + availability: v1.availability, + path: v1.path.parts.filter((part) => part.value !== ""), + messages, + auth: v1.auth ? [AUTH_SCHEME_ID] : undefined, + defaultEnvironment: v1.defaultEnvironment, + environments: v1.environments, + pathParameters: this.migrateParameters(v1.path.pathParameters), + queryParameters: this.migrateParameters(v1.queryParameters), + requestHeaders: this.migrateParameters(v1.headers), + examples: this.migrateChannelExamples(v1.examples, messages), + }; + }; + + migrateWebhook = ( + id: V2.WebhookId, + v1: APIV1Read.WebhookDefinition, + namespace: V2.SubpackageId[], + ): V2.WebhookDefinition => { + const payload = this.migrateWebhookPayload(v1.payload); + return { + id, + namespace, + description: v1.description, + availability: undefined, + method: v1.method, + path: v1.path, + headers: this.migrateParameters(v1.headers), + payload, + examples: v1.examples.map((example) => ({ + ...example, + payload: sortKeysByShape(example.payload, payload.shape, this.types), + })), + }; + }; + + migrateSubpackage = (subpackage: APIV1Read.ApiDefinitionSubpackage): V2.SubpackageMetadata => { + return { + id: subpackage.subpackageId, + name: subpackage.name, + displayName: subpackage.displayName, + }; + }; + + migrateParameters = ( + v1: APIV1Read.PathParameter[] | APIV1Read.QueryParameter[] | APIV1Read.Header[] | undefined, + ): V2.ObjectProperty[] | undefined => { + if (v1 == null || v1.length === 0) { + return undefined; + } + return v1.map((parameter) => ({ + key: V2.PropertyKey(parameter.key), + valueShape: this.migrateTypeReference(parameter.type), + description: parameter.description, + availability: parameter.availability, + })); + }; + + migrateTypeReference = (typeRef: APIV1Read.TypeReference): V2.TypeReference => { + return visitDiscriminatedUnion(typeRef)._visit({ + map: (value) => ({ + type: "map", + keyShape: this.migrateTypeReference(value.keyType), + valueShape: this.migrateTypeReference(value.valueType), + }), + id: (value) => ({ + type: "id", + id: value.value, + default: value.default, + }), + primitive: (value) => value, + optional: (value) => ({ + type: "optional", + shape: this.migrateTypeReference(value.itemType), + default: value.defaultValue, + }), + list: (value) => ({ + type: "list", + itemShape: this.migrateTypeReference(value.itemType), + }), + set: (value) => ({ + type: "set", + itemShape: this.migrateTypeReference(value.itemType), + }), + literal: (value) => value, + unknown: () => ({ + type: "unknown", + displayName: undefined, + }), + }); + }; + + migrateTypeShape = (shape: APIV1Read.TypeShape): V2.TypeShape => { + return visitDiscriminatedUnion(shape)._visit({ + object: (value) => ({ + type: "object", + extends: value.extends, + properties: this.migrateObjectProperties(value.properties), + }), + alias: (value) => ({ + type: "alias", + value: this.migrateTypeReference(value.value), + }), + enum: (value) => value, + undiscriminatedUnion: (value) => ({ + type: "undiscriminatedUnion", + variants: value.variants.map((variant) => ({ + displayName: variant.displayName, + shape: this.migrateTypeReference(variant.type), + description: variant.description, + availability: variant.availability, + })), + }), + discriminatedUnion: (value) => ({ + type: "discriminatedUnion", + discriminant: V2.PropertyKey(value.discriminant), + variants: value.variants.map((variant) => ({ + discriminantValue: variant.discriminantValue, + displayName: variant.displayName, + description: variant.description, + availability: variant.availability, + extends: variant.additionalProperties.extends, + properties: this.migrateObjectProperties(variant.additionalProperties.properties), + })), + }), + }); + }; + + migrateObjectProperties = (properties: APIV1Read.ObjectProperty[]): V2.ObjectProperty[] => { + return properties.map((value) => ({ + key: V2.PropertyKey(value.key), + valueShape: this.migrateTypeReference(value.valueType), + description: value.description, + availability: value.availability, + })); + }; + + migrateJsonShape = (shape: APIV1Read.JsonBodyShape): V2.TypeShape => { + return visitDiscriminatedUnion(shape)._visit({ + object: this.migrateTypeShape, + reference: (ref) => ({ type: "alias", value: this.migrateTypeReference(ref.value) }), + }); + }; + + migrateWebhookPayload = (payload: APIV1Read.WebhookPayload): V2.WebhookPayload => { + return { + description: payload.description, + shape: this.migrateJsonShape(payload.type), + }; + }; + + migrateChannelExamples = ( + examples: APIV1Read.ExampleWebSocketSession[], + messages: V2.WebSocketMessage[], + ): V2.ExampleWebSocketSession[] | undefined => { + if (examples.length === 0) { + return undefined; + } + + return examples.map((example) => ({ + description: example.description, + path: example.path, + name: example.name, + pathParameters: example.pathParameters, + queryParameters: example.queryParameters, + requestHeaders: example.headers, + messages: example.messages.map((example) => ({ + ...example, + body: sortKeysByShape( + example.body, + messages.find((message) => message.type === example.type)?.body, + this.types, + ), + })), + })); + }; + + migrateChannelMessages = (messages: APIV1Read.WebSocketMessage[]): V2.WebSocketMessage[] => { + return messages.map((message) => ({ + type: message.type, + displayName: message.displayName, + origin: message.origin, + body: this.migrateJsonShape(message.body), + description: message.description, + availability: message.availability, + })); + }; + + migrateHttpExamples = ( + examples: APIV1Read.ExampleEndpointCall[], + endpoint: V2.EndpointDefinition, + ): V2.ExampleEndpointCall[] | undefined => { + if (examples.length === 0) { + return undefined; + } + return examples.map((example): V2.ExampleEndpointCall => { + const toRet: V2.ExampleEndpointCall = { + path: example.path, + responseStatusCode: example.responseStatusCode, + name: example.name, + description: example.description, + pathParameters: example.pathParameters, + queryParameters: example.queryParameters, + headers: example.headers, + requestBody: example.requestBodyV3, + responseBody: example.responseBodyV3, + snippets: undefined, + }; + + if (example.requestBodyV3) { + toRet.requestBody = visitDiscriminatedUnion( + example.requestBodyV3, + )._visit({ + bytes: (value) => value, + json: (value) => ({ + type: "json", + value: sortKeysByShape(value.value, endpoint.request?.body, this.types), + }), + form: (value) => ({ + type: "form", + value: mapValues(value.value, (formValue, key): APIV1Read.FormValue => { + if (formValue.type === "json") { + const shape = + endpoint.request?.body.type === "formData" + ? endpoint.request.body.fields.find( + (field): field is V2.FormDataField.Property => + field.key === key && field.type === "property", + )?.valueShape + : undefined; + return { + type: "json", + value: sortKeysByShape(formValue.value, shape, this.types), + }; + } else { + return formValue; + } + }), + }), + }); + } + + if (toRet.responseBody) { + toRet.responseBody.value = sortKeysByShape( + toRet.responseBody.value, + endpoint.response?.body, + this.types, + ); + } + + toRet.snippets = this.migrateEndpointSnippets( + endpoint, + toRet, + example.codeSamples, + example.codeExamples, + this.flags, + ); + + return toRet; + }); + }; + + migrateHttpErrors = (errors: APIV1Read.ErrorDeclarationV2[] | undefined): V2.ErrorResponse[] | undefined => { + if (errors == null || errors.length === 0) { + return undefined; + } + + return errors.map((value) => { + const shape = value.type != null ? this.migrateTypeShape(value.type) : undefined; + return { + description: value.description, + availability: value.availability, + name: value.name, + statusCode: value.statusCode, + shape, + examples: value.examples?.map( + (example): APIV1Read.ErrorExample => ({ + description: example.description, + name: example.name, + responseBody: { + type: "json" as const, + value: sortKeysByShape(example.responseBody.value, shape, this.types), + }, + }), + ), + }; + }); + }; + + migrateHttpResponse = (response: APIV1Read.HttpResponse | undefined): V2.HttpResponse | undefined => { + if (response == null) { + return undefined; + } + + return { + description: response.description, + statusCode: response.statusCode ?? 200, + body: visitDiscriminatedUnion(response.type)._visit({ + object: (value) => ({ + type: "object", + extends: value.extends, + properties: this.migrateObjectProperties(value.properties), + }), + reference: (value) => ({ + type: "alias", + value: this.migrateTypeReference(value.value), + }), + fileDownload: (value) => value, + streamingText: (value) => value, + stream: (value) => ({ + type: "stream", + terminator: value.terminator, + shape: this.migrateJsonShape(value.shape), + }), + + // Careful! we're dropping non-streaming response shape in the following migration: + streamCondition: (value) => ({ + type: "stream", + terminator: undefined, + shape: this.migrateJsonShape(value.streamResponse.shape), + }), + }), + }; + }; + + migrateHttpRequest = (request: APIV1Read.HttpRequest | undefined): V2.HttpRequest | undefined => { + if (request == null) { + return undefined; + } + + return { + description: request.description, + contentType: request.contentType, + body: visitDiscriminatedUnion(request.type)._visit({ + object: (value) => ({ + type: "object", + extends: value.extends, + properties: this.migrateObjectProperties(value.properties), + }), + reference: (value) => ({ + type: "alias", + value: this.migrateTypeReference(value.value), + }), + bytes: (value) => ({ + type: "bytes", + isOptional: value.isOptional, + contentType: value.contentType, + }), + formData: (value) => ({ + type: "formData", + description: value.description, + availability: value.availability, + fields: this.migrateFormDataProperties(value.properties), + }), + fileUpload: (value) => ({ + type: "formData", + description: value.value?.description, + availability: value.value?.availability, + fields: this.migrateFormDataProperties(value.value?.properties ?? []), + }), + }), + }; + }; + + migrateFormDataProperties = (properties: APIV1Read.FormDataProperty[]): V2.FormDataField[] => { + return properties.map((prop) => + visitDiscriminatedUnion(prop)._visit({ + file: (file) => + visitDiscriminatedUnion(file.value)._visit({ + file: (single) => ({ + type: "file", + key: single.key, + isOptional: single.isOptional, + contentType: single.contentType, + description: single.description, + availability: single.availability, + }), + fileArray: (multiple) => ({ + type: "files", + key: multiple.key, + isOptional: multiple.isOptional, + contentType: multiple.contentType, + description: multiple.description, + availability: multiple.availability, + }), + }), + bodyProperty: (bodyProp) => ({ + type: "property", + key: bodyProp.key, + contentType: bodyProp.contentType, + description: bodyProp.description, + availability: bodyProp.availability, + valueShape: this.migrateTypeReference(bodyProp.valueType), + }), + }), + ); + }; + + migrateEndpointSnippets( + endpoint: V2.EndpointDefinition, + example: V2.ExampleEndpointCall, + codeSamples: APIV1Read.CustomCodeSample[], + codeExamples: APIV1Read.CodeExamples, + flags: Flags, + ): Record { + const toRet: Record = {}; + function push(language: string, snippet: V2.CodeSnippet) { + (toRet[language] ??= []).push(snippet); + } + + const userProvidedLanguages = new Set(); + + // Add user-provided code snippets + codeSamples.forEach((codeSample) => { + const language = this.#cleanLanguage(codeSample.language); + userProvidedLanguages.add(language); + + push(language, { + name: codeSample.name, + language, + install: codeSample.install, + code: codeSample.code, + generated: false, + description: codeSample.description, + }); + }); + + if (!userProvidedLanguages.has(SupportedLanguage.Curl)) { + const code = convertToCurl(toHttpRequest(endpoint, example, this.auth), flags); + push(SupportedLanguage.Curl, { + language: SupportedLanguage.Curl, + code, + name: undefined, + install: undefined, + generated: true, + description: undefined, + }); + } + + if (!userProvidedLanguages.has(SupportedLanguage.Python) && codeExamples.pythonSdk != null) { + push(SupportedLanguage.Python, { + name: undefined, + language: SupportedLanguage.Python, + install: codeExamples.pythonSdk.install, + code: codeExamples.pythonSdk.sync_client, + generated: true, + description: undefined, + }); + } + + const jsLang = flags.useJavaScriptAsTypeScript ? SupportedLanguage.Javascript : SupportedLanguage.Typescript; + const jsLangName = flags.useJavaScriptAsTypeScript ? "JavaScript" : "TypeScript"; + if ( + !flags.alwaysEnableJavaScriptFetch && + !userProvidedLanguages.has(jsLang) && + codeExamples.typescriptSdk != null + ) { + push(jsLang, { + name: `${jsLangName} SDK`, + language: jsLang, + install: codeExamples.typescriptSdk.install, + code: codeExamples.typescriptSdk.client, + generated: true, + description: undefined, + }); + } + + if (!userProvidedLanguages.has(SupportedLanguage.Go) && codeExamples.goSdk != null) { + push(SupportedLanguage.Go, { + name: undefined, + language: SupportedLanguage.Go, + install: codeExamples.goSdk.install, + code: codeExamples.goSdk.client, + generated: true, + description: undefined, + }); + } + + if (!userProvidedLanguages.has(SupportedLanguage.Ruby) && codeExamples.rubySdk != null) { + push(SupportedLanguage.Ruby, { + name: undefined, + language: SupportedLanguage.Ruby, + install: codeExamples.rubySdk.install, + code: codeExamples.rubySdk.client, + generated: true, + description: undefined, + }); + } + + return toRet; + } + + #cleanLanguage(language: string): string { + language = language.toLowerCase().trim(); + if (["node", "nodejs", "js", "javascript"].includes(language)) { + return SupportedLanguage.Javascript; + } + + if (["py", "python"].includes(language)) { + return SupportedLanguage.Python; + } + + if (["ts", "typescript", "ts-node"].includes(language)) { + return SupportedLanguage.Typescript; + } + + if (["go", "golang"].includes(language)) { + return SupportedLanguage.Go; + } + + return language; + } +} diff --git a/packages/fdr-sdk/src/api-definition/prune.ts b/packages/fdr-sdk/src/api-definition/prune.ts new file mode 100644 index 0000000000..a56f906e27 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/prune.ts @@ -0,0 +1,143 @@ +import { LOOP_TOLERANCE } from "./const"; +import type * as Latest from "./latest"; +import { ApiTypeIdVisitor } from "./typeid-visitor"; + +type NodeType = + | { type: "endpoint"; endpointId: Latest.EndpointId } + | { type: "webSocket"; webSocketId: Latest.WebSocketId } + | { type: "webhook"; webhookId: Latest.WebhookId }; + +class ApiDefinitionPruner { + static instances = new WeakMap(); + + static from(api: Latest.ApiDefinition): ApiDefinitionPruner { + const toRet = ApiDefinitionPruner.instances.get(api) ?? new ApiDefinitionPruner(api); + ApiDefinitionPruner.instances.set(api, toRet); + return toRet; + } + + private constructor(private api: Latest.ApiDefinition) {} + + /** + * This utility is designed to prune an API definition to only include the desired endpoints, websockets, and webhooks + * based on the provided node of the navigation tree, which will reduce the size of the API definition that is sent to the client. + * + * @param node of the navigation tree to prune the API definition to + * @returns a new API definition that is the result of pruning the input API definition to the desired node + */ + public prune(node: NodeType): Latest.ApiDefinition { + const toRet: Latest.ApiDefinition = { + ...this.api, + endpoints: {}, + websockets: {}, + webhooks: {}, + types: {}, + subpackages: {}, + auths: {}, + }; + + const namespaces = new Set(); + const authSchemes = new Set(); + + if (node.type === "endpoint") { + const found = this.api.endpoints[node.endpointId]; + if (found) { + toRet.endpoints[node.endpointId] = found; + found.namespace?.forEach((subpackageId) => namespaces.add(subpackageId)); + found.auth?.forEach((authSchemeId) => authSchemes.add(authSchemeId)); + } + } else if (node.type === "webSocket") { + const found = this.api.websockets[node.webSocketId]; + if (found) { + toRet.websockets[node.webSocketId] = found; + found.namespace?.forEach((subpackageId) => namespaces.add(subpackageId)); + found.auth?.forEach((authSchemeId) => authSchemes.add(authSchemeId)); + } + } else if (node.type === "webhook") { + const found = this.api.webhooks[node.webhookId]; + if (found) { + toRet.webhooks[node.webhookId] = found; + found.namespace?.forEach((subpackageId) => namespaces.add(subpackageId)); + } + } + + toRet.types = this.pruneTypes(toRet); + namespaces.forEach((subpackageId) => { + const subpackage = this.api.subpackages[subpackageId]; + if (subpackage) { + toRet.subpackages[subpackageId] = subpackage; + } + }); + authSchemes.forEach((authSchemeId) => { + const authScheme = this.api.auths[authSchemeId]; + if (authScheme) { + toRet.auths[authSchemeId] = authScheme; + } + }); + + return toRet; + } + + private pruneTypes(partiallyPrunedApi: Latest.ApiDefinition): Record { + let typeIds = new Set(); + partiallyPrunedApi.globalHeaders?.forEach((header) => { + ApiTypeIdVisitor.visitTypeReference(header.valueShape, (typeId) => typeIds.add(typeId)); + }); + + for (const endpoint of Object.values(partiallyPrunedApi.endpoints)) { + ApiTypeIdVisitor.visitEndpointDefinition(endpoint, (typeId) => typeIds.add(typeId)); + } + + for (const websocket of Object.values(partiallyPrunedApi.websockets)) { + ApiTypeIdVisitor.visitWebSocketChannel(websocket, (typeId) => typeIds.add(typeId)); + } + + for (const webhook of Object.values(partiallyPrunedApi.webhooks)) { + ApiTypeIdVisitor.visitWebhookDefinition(webhook, (typeId) => typeIds.add(typeId)); + } + + typeIds = this.expandTypeIds(typeIds); + + const types: Record = {}; + + typeIds.forEach((typeId) => { + const type = this.api.types[typeId]; + if (type != null) { + types[typeId] = type; + } + }); + + return types; + } + + private expandTypeIds(typeIds: Set): Set { + const visitedTypeIds = new Set(); + const queue = Array.from(typeIds); + + let loop = 0; + while (queue.length > 0) { + if (loop > LOOP_TOLERANCE) { + throw new Error("Infinite loop detected while expanding type references."); + } + + const typeId = queue.pop(); + if (typeId != null && !visitedTypeIds.has(typeId)) { + visitedTypeIds.add(typeId); + const type = this.api.types[typeId]; + if (type) { + ApiTypeIdVisitor.visitTypeDefinition(type, (nestedTypeId) => { + queue.push(nestedTypeId); + }); + } + } + + loop++; + } + + return visitedTypeIds; + } +} + +export function prune(api: Latest.ApiDefinition, node: NodeType): Latest.ApiDefinition { + return ApiDefinitionPruner.from(api).prune(node); +} diff --git a/packages/fdr-sdk/src/api-definition/snippets/HttpRequest.ts b/packages/fdr-sdk/src/api-definition/snippets/HttpRequest.ts new file mode 100644 index 0000000000..db776080bb --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/snippets/HttpRequest.ts @@ -0,0 +1,153 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; +import compact from "lodash-es/compact"; +import { noop } from "ts-essentials"; +import urljoin from "url-join"; +import type * as Latest from "../latest"; + +interface HttpRequestBodyJson { + type: "json"; + value?: unknown; +} + +interface HttpRequestBodyForm { + type: "form"; + value: Record; +} + +interface HttpRequestBodyFormValueFilename { + type: "filename"; + filename: string; + contentType: string | undefined; +} + +interface HttpRequestBodyFormValueFilenames { + type: "filenames"; + files: Omit[]; +} + +type HttpRequestBodyFormValue = + | HttpRequestBodyJson + | HttpRequestBodyFormValueFilename + | HttpRequestBodyFormValueFilenames; + +interface HttpRequestBodyBytes { + type: "bytes"; + filename: string; +} + +type HttpRequestBody = HttpRequestBodyJson | HttpRequestBodyForm | HttpRequestBodyBytes; + +export interface HttpRequest { + method: string; + url: string; + searchParams: Record; + headers: Record; + basicAuth?: { + username: string; + password: string; + }; + body: HttpRequestBody | undefined; +} + +// TODO: validate that global headers are also included in the example by CLI or FDR +export function toHttpRequest( + endpoint: Latest.EndpointDefinition, + example: Latest.ExampleEndpointCall, + auth: Latest.AuthScheme | undefined, +): HttpRequest { + const environmentUrl = ( + endpoint.environments?.find((env) => env.id === endpoint.defaultEnvironment) ?? endpoint.environments?.[0] + )?.baseUrl; + const url = urljoin(compact([environmentUrl, example.path])); + + const headers: Record = { ...example.headers }; + + let basicAuth: { username: string; password: string } | undefined; + + if (endpoint.auth && endpoint.auth.length > 0 && auth) { + visitDiscriminatedUnion(auth, "type")._visit({ + basicAuth: ({ usernameName = "username", passwordName = "password" }) => { + basicAuth = { username: `<${usernameName}>`, password: `<${passwordName}>` }; + }, + bearerAuth: ({ tokenName = "token" }) => { + headers.Authorization = `Bearer <${tokenName}>`; + }, + header: ({ headerWireValue, nameOverride = headerWireValue, prefix }) => { + headers[headerWireValue] = prefix != null ? `${prefix} <${nameOverride}>` : `<${nameOverride}>`; + }, + oAuth: ({ value: clientCredentials }) => { + visitDiscriminatedUnion(clientCredentials, "type")._visit({ + clientCredentials: () => { + headers.Authorization = "Bearer "; + }, + _other: noop, + }); + }, + _other: noop, + }); + } + + const body: Latest.ExampleEndpointRequest | undefined = example.requestBody; + + if (endpoint.request?.contentType != null) { + headers["Content-Type"] = endpoint.request?.contentType; + } + + if (body != null && headers["Content-Type"] == null) { + if (body.type === "json") { + headers["Content-Type"] = "application/json"; + } else if (body.type === "form") { + headers["Content-Type"] = "multipart/form-data"; + } + } + + return { + method: endpoint.method, + url, + searchParams: example.queryParameters ?? {}, + headers: JSON.parse(JSON.stringify(headers)), + basicAuth, + body: + body == null + ? undefined + : visitDiscriminatedUnion(body)._visit({ + json: (value) => value, + form: (value) => { + const toRet: Record = {}; + for (const [key, val] of Object.entries(value.value)) { + toRet[key] = visitDiscriminatedUnion(val)._visit({ + json: (value) => value, + filename: (value) => ({ + type: "filename", + filename: value.value, + contentType: undefined, // TODO: infer content type? + }), + filenames: (value) => ({ + type: "filenames", + files: value.value.map((filename) => ({ + filename, + contentType: undefined, // TODO: infer content type? + })), + }), + filenameWithData: (value) => ({ + type: "filename", + filename: value.filename, + contentType: undefined, // TODO: infer content type? + }), + filenamesWithData: (value) => ({ + type: "filenames", + files: value.value.map(({ filename }) => ({ + filename, + contentType: undefined, // TODO: infer content type? + })), + }), + }); + } + return { type: "form", value: toRet }; + }, + // TODO: filename should be provided in the example from the API definition + bytes: () => ({ type: "bytes", filename: "" }), + _other: () => undefined, + }), + }; +} diff --git a/packages/fdr-sdk/src/api-definition/snippets/curl.ts b/packages/fdr-sdk/src/api-definition/snippets/curl.ts new file mode 100644 index 0000000000..2320a8fbc2 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/snippets/curl.ts @@ -0,0 +1,114 @@ +import { unknownToString } from "@fern-ui/core-utils"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; +import { HttpRequest } from "./HttpRequest"; + +function requiresUrlEncode(str: string): boolean { + return encodeURIComponent(str) !== str; +} + +interface Flags { + usesApplicationJsonInFormDataValue: boolean; +} + +export function convertToCurl(request: HttpRequest, opts: Flags): string { + try { + return unsafeStringifyHttpRequestExampleToCurl(request, opts); + } catch (e) { + // eslint-disable-next-line no-console + console.error(e); + + return ""; + } +} + +function unsafeStringifyHttpRequestExampleToCurl( + { method, url, searchParams, headers, basicAuth, body }: HttpRequest, + { usesApplicationJsonInFormDataValue }: Flags, +): string { + const queryParams = toUrlEncoded(searchParams) + .map(([key, value]) => `${key}=${encodeURIComponent(unknownToString(value))}`) + .join("&"); + const httpRequest = + method !== "GET" + ? queryParams.length > 0 + ? `-X ${method} "${url}?${queryParams}"` + : `-X ${method} ${url}` + : queryParams.length > 0 + ? `-G ${url}` + : url; + const headersString = Object.entries(headers) + .map(([key, value]) => ` \\\n -H "${key}: ${value}"`) + .join(""); + const basicAuthString = basicAuth != null ? ` \\\n -u "${basicAuth.username}:${basicAuth.password}"` : ""; + + // GET requests don't have a body, so `--data-urlencode` is used to pass query parameters + const urlQueriesGetString = + method === "GET" + ? toUrlEncoded(searchParams) + .map( + ([key, value]) => + ` \\\n ${requiresUrlEncode(value) ? "--data-urlencode" : "-d"} ${key.includes("[") ? `"${key}"` : key}=${value.includes(" ") ? `"${value}"` : value}`, + ) + .join("") + : ""; + + const bodyDataString = + body == null || method === "GET" + ? "" + : visitDiscriminatedUnion(body)._visit({ + json: ({ value }) => + value == null + ? "" + : ` \\\n -d ${typeof value === "string" ? `"${value.replace(/"/g, '\\"')}"` : `'${JSON.stringify(value, null, 2).replace(/'/g, "\\'")}'`}`, + form: ({ value }) => + Object.entries(value) + .map(([key, value]) => + visitDiscriminatedUnion(value)._visit({ + json: ({ value }) => { + if (value == null) { + return ""; + } + + if (typeof value === "string") { + return ` \\\n -F ${key}="${value.replace(/"/g, '\\"')}${usesApplicationJsonInFormDataValue ? ";type=application/json" : ""}"`; + } + + const stringValue = JSON.stringify(value, null, 2); + + return ` \\\n -F ${key}='${stringValue.replace(/'/g, "'\\''")}${usesApplicationJsonInFormDataValue ? ";type=application/json" : ""}'`; + }, + filename: ({ filename, contentType }) => { + if (filename == null) { + return ""; + } + return ` \\\n -F ${key}=@${filename.includes(" ") || contentType != null ? `"${filename}${contentType != null ? `;type=${contentType}` : ""}"` : filename}`; + }, + filenames: ({ files }) => + files + .filter((file) => file.filename != null) + .map( + ({ filename, contentType }) => + ` \\\n -F "${key}[]"=@${filename.includes(" ") || contentType != null ? `"${filename}${contentType != null ? `;type=${contentType}` : ""}"` : filename}`, + ) + .join(""), + _other: () => "", + }), + ) + .join(""), + bytes: ({ filename }) => { + return ` \\\n --data-binary @${filename.includes(" ") ? `"${filename}"` : filename}`; + }, + _other: () => "", + }); + + return `curl ${httpRequest}${headersString}${basicAuthString}${urlQueriesGetString}${bodyDataString}`; +} + +function toUrlEncoded(urlQueries: Record): Array<[string, string]> { + return Object.entries(urlQueries).flatMap(([key, value]): [string, string][] => { + if (Array.isArray(value)) { + return value.map((v) => [`${key}[]`, unknownToString(v)]); + } + return [[key, unknownToString(value)]]; + }); +} diff --git a/packages/fdr-sdk/src/api-definition/sort-keys.ts b/packages/fdr-sdk/src/api-definition/sort-keys.ts new file mode 100644 index 0000000000..b71a0032d7 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/sort-keys.ts @@ -0,0 +1,135 @@ +import isPlainObject from "@fern-ui/core-utils/isPlainObject"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; +import difference from "lodash-es/difference"; +import keyBy from "lodash-es/keyBy"; +import mapValues from "lodash-es/mapValues"; +import type * as Latest from "./latest"; +import { TypeShapeOrReference } from "./types"; +import { unwrapDiscriminatedUnionVariant, unwrapObjectType } from "./unwrap"; + +function sortKeysBy(obj: Record, order: string[]): Record { + return mapValues( + // difference() is used to ensure that all keys are included in the result + keyBy([...order, ...difference(Object.keys(obj), order)], (key) => key), + (key) => obj[key], + ); +} + +export function sortKeysByShape( + obj: unknown, + shape: TypeShapeOrReference | Latest.HttpRequestBodyShape | Latest.HttpResponseBodyShape | null | undefined, + types: Record, +): unknown { + if ((!isPlainObject(obj) && !Array.isArray(obj)) || shape == null) { + return obj; + } + return visitDiscriminatedUnion(shape, "type")._visit({ + id: ({ id }) => sortKeysByShape(obj, types[id]?.shape, types), + primitive: () => obj, + literal: () => obj, + optional: ({ shape }) => sortKeysByShape(obj, shape, types), + list: ({ itemShape }) => (Array.isArray(obj) ? obj.map((o) => sortKeysByShape(o, itemShape, types)) : obj), + set: ({ itemShape }) => (Array.isArray(obj) ? obj.map((o) => sortKeysByShape(o, itemShape, types)) : obj), + map: ({ valueShape }) => + isPlainObject(obj) ? mapValues(obj, (value) => sortKeysByShape(value, valueShape, types)) : obj, + unknown: () => obj, + object: (object) => { + const objectProperties = unwrapObjectType(object, types).properties; + return isPlainObject(obj) + ? mapValues( + sortKeysBy( + obj, + objectProperties.map((p) => p.key), + ), + (value, key) => { + const property = objectProperties.find((p) => p.key === key); + if (property == null) { + return value; + } + return sortKeysByShape(value, property?.valueShape, types); + }, + ) + : obj; + }, + undiscriminatedUnion: () => obj, // TODO: match variant and sort nested objects + discriminatedUnion: (union) => { + const { discriminant, variants } = union; + if (!isPlainObject(obj)) { + return obj; + } + const variant = obj[discriminant]; + if (variant == null) { + return obj; + } + const variantShape = variants.find((v) => v.discriminantValue === variant); + if (variantShape == null) { + return obj; + } + const variantProperties = unwrapDiscriminatedUnionVariant(union, variantShape, types).properties; + return mapValues(sortKeysBy(obj, [discriminant, ...variantProperties.map((p) => p.key)]), (value, key) => { + if (key === discriminant) { + return value; + } + const property = variantProperties.find((p) => p.key === key); + if (property == null) { + return value; + } + return sortKeysByShape(value, property.valueShape, types); + }); + }, + enum: () => obj, + alias: ({ value: typeRef }) => sortKeysByShape(obj, typeRef, types), + formData: ({ fields }) => { + if (!isPlainObject(obj)) { + return obj; + } + + return mapValues( + sortKeysBy( + obj, + fields.map((p) => p.key), + ), + (v, key) => { + const property = fields.find((p) => p.key === key); + + if (property == null) { + return v; + } + + if (property.type === "property") { + return sortKeysByShape(v, property.valueShape, types); + } + + return undefined; + }, + ); + }, + bytes: () => obj, + fileDownload: () => obj, + streamingText: () => obj, + stream: () => obj, + _other: () => obj, + }); +} + +export function safeSortKeysByShape( + value: unknown, + shape: TypeShapeOrReference | Latest.HttpRequestBodyShape | Latest.HttpResponseBodyShape | null | undefined, + types: Record, +): unknown { + if (value == null) { + return value; + } + try { + return stripUndefines(sortKeysByShape(value, shape, types)); + } catch (e) { + // eslint-disable-next-line no-console + console.error("Failed to sort JSON keys by type shape", e); + + return value; + } +} + +function stripUndefines(obj: unknown): unknown { + return JSON.parse(JSON.stringify(obj)); +} diff --git a/packages/fdr-sdk/src/api-definition/transformer.ts b/packages/fdr-sdk/src/api-definition/transformer.ts new file mode 100644 index 0000000000..4d4d97d10a --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/transformer.ts @@ -0,0 +1,535 @@ +import type * as FernDocs from "@fern-api/fdr-sdk/docs"; +import identity from "@fern-ui/core-utils/identity"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; +import { AsyncOrSync } from "ts-essentials"; +import * as Latest from "./latest"; + +/** + * Visitor for API definitions. + * This is used to traverse the API definition and apply async functions to each node. + */ +export interface ApiDefinitionVisitor { + // endpoints + EndpointDefinition(endpoint: Latest.EndpointDefinition, key: string): AsyncOrSync; + HttpRequest(request: Latest.HttpRequest, key: string): AsyncOrSync; + HttpResponse(response: Latest.HttpResponse, key: string): AsyncOrSync; + ErrorResponse(error: Latest.ErrorResponse, key: string): AsyncOrSync; + ExampleEndpointCall(example: Latest.ExampleEndpointCall, key: string): AsyncOrSync; + CodeSnippet(snippet: Latest.CodeSnippet, key: string): AsyncOrSync; + ErrorExample(error: Latest.ErrorExample, key: string): AsyncOrSync; + + // webhooks + WebhookDefinition(webhook: Latest.WebhookDefinition, key: string): AsyncOrSync; + WebhookPayload(payload: Latest.WebhookPayload, key: string): AsyncOrSync; + + // websockets + WebSocketChannel(channel: Latest.WebSocketChannel, key: string): AsyncOrSync; + WebSocketMessage(message: Latest.WebSocketMessage, key: string): AsyncOrSync; + ExampleWebSocketSession( + session: Latest.ExampleWebSocketSession, + key: string, + ): AsyncOrSync; + + // types + TypeDefinition(type: Latest.TypeDefinition, key: string): AsyncOrSync; + TypeShape(shape: Latest.TypeShape, key: string): AsyncOrSync; + ObjectType(property: Latest.ObjectType, key: string): AsyncOrSync; + ObjectProperty(property: Latest.ObjectProperty, key: string): AsyncOrSync; + EnumValue(value: Latest.EnumValue, key: string): AsyncOrSync; + UndiscriminatedUnionVariant( + variant: Latest.UndiscriminatedUnionVariant, + key: string, + ): AsyncOrSync; + DiscriminatedUnionVariant( + variant: Latest.DiscriminatedUnionVariant, + key: string, + ): AsyncOrSync; + FormDataRequest(request: Latest.FormDataRequest, key: string): AsyncOrSync; + FormDataField(field: Latest.FormDataField, key: string): AsyncOrSync; + FormDataFile(file: Latest.FormDataFile, key: string): AsyncOrSync; + FormDataFiles(files: Latest.FormDataFiles, key: string): AsyncOrSync; +} + +export class Transformer { + public static with(visitor: ApiDefinitionVisitor): Transformer { + return new Transformer(visitor); + } + + public static descriptions( + transformer: (description: FernDocs.MarkdownText, key: string) => AsyncOrSync, + ): Transformer { + async function internalTransformer( + withDescription: T, + key: string, + ): Promise { + const description = + withDescription.description != null ? await transformer(withDescription.description, key) : undefined; + return { ...withDescription, description }; + } + + return Transformer.with({ + EndpointDefinition: internalTransformer, + HttpRequest: internalTransformer, + HttpResponse: internalTransformer, + ErrorResponse: internalTransformer, + ExampleEndpointCall: internalTransformer, + CodeSnippet: internalTransformer, + ErrorExample: internalTransformer, + WebhookDefinition: internalTransformer, + WebhookPayload: internalTransformer, + WebSocketChannel: internalTransformer, + WebSocketMessage: internalTransformer, + ExampleWebSocketSession: internalTransformer, + TypeDefinition: internalTransformer, + ObjectProperty: internalTransformer, + EnumValue: internalTransformer, + UndiscriminatedUnionVariant: internalTransformer, + DiscriminatedUnionVariant: internalTransformer, + FormDataRequest: internalTransformer, + FormDataField: internalTransformer, + FormDataFile: internalTransformer, + FormDataFiles: internalTransformer, + + // These types do not have descriptions + TypeShape: identity, + ObjectType: identity, + }); + } + + /** + * @internal visible for testing only + */ + public static keys(collect: (key: string) => void): Transformer { + function visit(value: T, key: string): T { + collect(key); + return value; + } + return Transformer.with({ + EndpointDefinition: visit, + HttpRequest: visit, + HttpResponse: visit, + ErrorResponse: visit, + ExampleEndpointCall: visit, + CodeSnippet: visit, + ErrorExample: visit, + WebhookDefinition: visit, + WebhookPayload: visit, + WebSocketChannel: visit, + WebSocketMessage: visit, + ExampleWebSocketSession: visit, + TypeDefinition: visit, + TypeShape: visit, + ObjectType: visit, + ObjectProperty: visit, + EnumValue: visit, + UndiscriminatedUnionVariant: visit, + DiscriminatedUnionVariant: visit, + FormDataRequest: visit, + FormDataField: visit, + FormDataFile: visit, + FormDataFiles: visit, + }); + } + + private visitor: ApiDefinitionVisitor; + private constructor(visitor: ApiDefinitionVisitor) { + this.visitor = this.#wrapVisitor(visitor); + } + + /** + * Visits an API definition and applies the visitor transformations to each node. + * + * This function treats the API Definition as an AST. The purpose is to apply transformations to the "description" field of each node. + * + * @param api the API definition to visit + * @param visitor the visitor to apply to the API definition + * @returns the API definition with the visitor transformations applied + */ + apiDefinition = async (api: Latest.ApiDefinition): Promise => { + const endpointsPromise = Promise.all( + Object.entries(api.endpoints).map(async ([id, endpoint]) => [ + id, + await this.visitor.EndpointDefinition(endpoint, `${api.id}/endpoint/${id}`), + ]), + ); + + const websocketsPromise = Promise.all( + Object.entries(api.websockets).map(async ([id, websocket]) => [ + id, + await this.visitor.WebSocketChannel(websocket, `${api.id}/websocket/${id}`), + ]), + ); + + const webhooksPromise = Promise.all( + Object.entries(api.webhooks).map(async ([id, webhook]) => [ + id, + await this.visitor.WebhookDefinition(webhook, `${api.id}/webhoook/${id}`), + ]), + ); + + const typesPromise = Promise.all( + Object.entries(api.types).map(async ([id, type]) => [ + id, + await this.visitor.TypeDefinition(type, `${api.id}/type-definition/${id}`), + ]), + ); + + const globalHeadersPromise = Promise.all( + api.globalHeaders?.map((header) => + this.visitor.ObjectProperty(header, `${api.id}/global-headers/${header.key}`), + ) ?? [], + ); + + const [endpoints, websockets, webhooks, types, globalHeaders] = await Promise.all([ + endpointsPromise, + websocketsPromise, + webhooksPromise, + typesPromise, + globalHeadersPromise, + ]); + + return { + id: api.id, + endpoints: Object.fromEntries(endpoints), + websockets: Object.fromEntries(websockets), + webhooks: Object.fromEntries(webhooks), + types: Object.fromEntries(types), + globalHeaders, + auths: api.auths, + subpackages: api.subpackages, + }; + }; + + #wrapVisitor = (visitor: ApiDefinitionVisitor): ApiDefinitionVisitor => { + const innerVisitor: ApiDefinitionVisitor = { + /** + * The following types do not have any nested types that need to be visited. + */ + + CodeSnippet: visitor.CodeSnippet, + ErrorExample: visitor.ErrorExample, + ExampleWebSocketSession: visitor.ExampleWebSocketSession, + ObjectProperty: visitor.ObjectProperty, + EnumValue: visitor.EnumValue, + UndiscriminatedUnionVariant: visitor.UndiscriminatedUnionVariant, + FormDataFile: visitor.FormDataFile, + FormDataFiles: visitor.FormDataFiles, + + /** + * The following types have nested types that need to be visited. + */ + + EndpointDefinition: async (endpoint, key) => + visitor.EndpointDefinition(await this.endpoint(endpoint, key), key), + HttpRequest: async (request, key) => visitor.HttpRequest(await this.httpRequest(request, key), key), + HttpResponse: async (response, key) => visitor.HttpResponse(await this.httpResponse(response, key), key), + ErrorResponse: async (error, key) => visitor.ErrorResponse(await this.errorResponse(error, key), key), + ExampleEndpointCall: async (example, key) => + visitor.ExampleEndpointCall(await this.exampleEndpointCall(example, key), key), + WebhookDefinition: async (webhook, key) => + visitor.WebhookDefinition(await this.webhookDefinition(webhook, key), key), + WebhookPayload: async (payload, key) => + visitor.WebhookPayload(await this.webhookPayload(payload, key), key), + WebSocketChannel: async (channel, key) => + visitor.WebSocketChannel(await this.webSocketChannel(channel, key), key), + WebSocketMessage: async (message, key) => + visitor.WebSocketMessage(await this.webSocketMessage(message, key), key), + TypeDefinition: async (type, key) => visitor.TypeDefinition(await this.typeDefinition(type, key), key), + TypeShape: async (shape, key) => visitor.TypeShape(await this.typeShape(shape, key), key), + ObjectType: async (type, key) => visitor.ObjectType(await this.objectType(type, key), key), + DiscriminatedUnionVariant: async (variant, key) => + visitor.DiscriminatedUnionVariant(await this.objectType(variant, key), key), + FormDataRequest: async (request, key) => + visitor.FormDataRequest(await this.formDataRequest(request, key), key), + FormDataField: async (field, key) => visitor.FormDataField(await this.formDataField(field, key), key), + }; + return innerVisitor; + }; + + endpoint = async (endpoint: Latest.EndpointDefinition, parentKey: string): Promise => { + const pathParametersPromise = Promise.all( + endpoint.pathParameters?.map((param) => + this.visitor.ObjectProperty(param, `${parentKey}/path/${param.key}`), + ) ?? [], + ); + const queryParametersPromise = Promise.all( + endpoint.queryParameters?.map((param) => + this.visitor.ObjectProperty(param, `${parentKey}/query/${param.key}`), + ) ?? [], + ); + const requestHeadersPromise = Promise.all( + endpoint.requestHeaders?.map((param) => + this.visitor.ObjectProperty(param, `${parentKey}/requestHeader/${param.key}`), + ) ?? [], + ); + const responseHeadersPromise = Promise.all( + endpoint.responseHeaders?.map((param) => + this.visitor.ObjectProperty(param, `${parentKey}/responseHeader/${param.key}`), + ) ?? [], + ); + const requestPromise = endpoint.request + ? this.visitor.HttpRequest(endpoint.request, `${parentKey}/request`) + : undefined; + const responsePromise = endpoint.response + ? this.visitor.HttpResponse(endpoint.response, `${parentKey}/response`) + : undefined; + const errorsPromise = Promise.all( + endpoint.errors?.map((error, i) => + this.visitor.ErrorResponse(error, `${parentKey}/error/${i}/${error.statusCode}`), + ) ?? [], + ); + const examplePromise = Promise.all( + endpoint.examples?.map((example, i) => + this.visitor.ExampleEndpointCall(example, `${parentKey}/example/${i}`), + ) ?? [], + ); + + const [pathParameters, queryParameters, requestHeaders, responseHeaders, request, response, errors, examples] = + await Promise.all([ + pathParametersPromise, + queryParametersPromise, + requestHeadersPromise, + responseHeadersPromise, + requestPromise, + responsePromise, + errorsPromise, + examplePromise, + ]); + + return { + ...endpoint, + pathParameters: pathParameters.length > 0 ? pathParameters : undefined, + queryParameters: queryParameters.length > 0 ? queryParameters : undefined, + requestHeaders: requestHeaders.length > 0 ? requestHeaders : undefined, + responseHeaders: responseHeaders.length > 0 ? responseHeaders : undefined, + request, + response, + errors: errors.length > 0 ? errors : undefined, + examples: examples.length > 0 ? examples : undefined, + }; + }; + + httpRequest = async (request: Latest.HttpRequest, parentKey: string): Promise => { + const bodyPromise = visitDiscriminatedUnion(request.body)._visit>({ + object: async (value) => ({ ...value, ...(await this.visitor.ObjectType(value, `${parentKey}/object`)) }), + alias: identity, + bytes: identity, + formData: async (value) => ({ + ...value, + ...(await this.visitor.FormDataRequest(value, `${parentKey}/formdata`)), + }), + }); + return { ...request, body: await bodyPromise }; + }; + + formDataField = async (field: Latest.FormDataField, parentKey: string): Promise => { + return visitDiscriminatedUnion(field)._visit>({ + file: async (value) => ({ + ...value, + ...(await this.visitor.FormDataFile(value, `${parentKey}/file/${value.key}`)), + }), + files: async (value) => ({ + ...value, + ...(await this.visitor.FormDataFiles(value, `${parentKey}/files/${value.key}`)), + }), + property: async (value) => ({ + ...value, + ...(await this.visitor.ObjectProperty(value, `${parentKey}/property/${value.key}`)), + }), + }); + }; + + httpResponse = async (response: Latest.HttpResponse, parentKey: string): Promise => { + const bodyPromise = visitDiscriminatedUnion(response.body)._visit>({ + object: async (value) => ({ ...value, ...(await this.visitor.ObjectType(value, `${parentKey}/object`)) }), + alias: identity, + fileDownload: identity, + streamingText: identity, + stream: async (value) => ({ + ...value, + shape: await this.visitor.TypeShape(value.shape, `${parentKey}/stream/shape`), + }), + }); + return { ...response, body: await bodyPromise }; + }; + + objectType = async (type: T, parentKey: string): Promise => { + const properties = await Promise.all( + type.properties.map((prop) => this.visitor.ObjectProperty(prop, `${parentKey}/property/${prop.key}`)), + ); + return { ...type, properties }; + }; + + errorResponse = async (error: Latest.ErrorResponse, parentKey: string): Promise => { + const shapePromise = error.shape ? this.visitor.TypeShape(error.shape, `${parentKey}/error/shape`) : undefined; + const examplesPromise = Promise.all( + error.examples?.map((example, i) => this.visitor.ErrorExample(example, `${parentKey}/example/${i}`)) ?? [], + ); + const [shape, examples] = await Promise.all([shapePromise, examplesPromise]); + return { ...error, shape, examples: examples.length > 0 ? examples : undefined }; + }; + + exampleEndpointCall = async ( + example: Latest.ExampleEndpointCall, + parentKey: string, + ): Promise => { + const snippetsEntries = ( + await Promise.all( + Object.entries(example.snippets ?? {}).map( + async ([language, snippets]) => + [ + language, + await Promise.all( + snippets.map((snippet, i) => + this.visitor.CodeSnippet(snippet, `${parentKey}/snippet/${language}/${i}`), + ), + ), + ] as const, + ), + ) + ).filter(([, snippets]) => snippets.length > 0); + + const snippets = Object.fromEntries(snippetsEntries); + return { + ...example, + snippets: snippetsEntries.length > 0 ? snippets : undefined, + }; + }; + + webhookDefinition = async ( + webhook: Latest.WebhookDefinition, + parentKey: string, + ): Promise => { + const payloadPromise = + webhook.payload != null ? this.visitor.WebhookPayload(webhook.payload, `${parentKey}/payload`) : undefined; + const headersPromise = Promise.all( + webhook.headers?.map((header) => + this.visitor.ObjectProperty(header, `${parentKey}/header/${header.key}`), + ) ?? [], + ); + const [payload, headers] = await Promise.all([payloadPromise, headersPromise]); + return { + ...webhook, + payload, + headers: headers.length > 0 ? headers : undefined, + }; + }; + + webhookPayload = async (payload: Latest.WebhookPayload, parentKey: string): Promise => { + const bodyPromise = this.visitor.TypeShape(payload.shape, `${parentKey}/shape`); + return { ...payload, shape: await bodyPromise }; + }; + + webSocketChannel = async ( + channel: Latest.WebSocketChannel, + parentKey: string, + ): Promise => { + const pathParametersPromise = Promise.all( + channel.pathParameters?.map((param) => + this.visitor.ObjectProperty(param, `${parentKey}/path/${param.key}`), + ) ?? [], + ); + const queryParametersPromise = Promise.all( + channel.queryParameters?.map((param) => + this.visitor.ObjectProperty(param, `${parentKey}/query/${param.key}`), + ) ?? [], + ); + const requestHeadersPromise = Promise.all( + channel.requestHeaders?.map((param) => + this.visitor.ObjectProperty(param, `${parentKey}/requestHeader/${param.key}`), + ) ?? [], + ); + const messagesPromise = Promise.all( + channel.messages.map((message) => + this.visitor.WebSocketMessage(message, `${parentKey}/message/${message.origin}/${message.type}`), + ), + ); + const examplesPromise = Promise.all( + channel.examples?.map((example, i) => + this.visitor.ExampleWebSocketSession(example, `${parentKey}/example/${i}`), + ) ?? [], + ); + const [pathParameters, queryParameters, requestHeaders, messages, examples] = await Promise.all([ + pathParametersPromise, + queryParametersPromise, + requestHeadersPromise, + messagesPromise, + examplesPromise, + ]); + return { + ...channel, + pathParameters: pathParameters.length > 0 ? pathParameters : undefined, + queryParameters: queryParameters.length > 0 ? queryParameters : undefined, + requestHeaders: requestHeaders.length > 0 ? requestHeaders : undefined, + messages, + examples: examples.length > 0 ? examples : undefined, + }; + }; + + webSocketMessage = async ( + message: Latest.WebSocketMessage, + parentKey: string, + ): Promise => { + const bodyPromise = this.visitor.TypeShape(message.body, `${parentKey}/body`); + return { + ...message, + body: await bodyPromise, + }; + }; + + typeShape = async (shape: Latest.TypeShape, parentKey: string): Promise => { + return await visitDiscriminatedUnion(shape)._visit>({ + object: async (value) => ({ + ...value, + ...(await this.visitor.ObjectType(value, `${parentKey}/object`)), + }), + alias: identity, + enum: async (value) => ({ + ...value, + values: await Promise.all( + value.values.map((enumValue) => + this.visitor.EnumValue(enumValue, `${parentKey}/enum/value/${enumValue.value}`), + ), + ), + }), + undiscriminatedUnion: async (value) => ({ + ...value, + variants: await Promise.all( + value.variants.map((variant, i) => + this.visitor.UndiscriminatedUnionVariant( + variant, + `${parentKey}/undiscriminatedUnion/variant/${i}`, + ), + ), + ), + }), + discriminatedUnion: async (value) => ({ + ...value, + variants: await Promise.all( + value.variants.map((variant) => + this.visitor.DiscriminatedUnionVariant( + variant, + `${parentKey}/discriminatedUnion/variant/${variant.discriminantValue}`, + ), + ), + ), + }), + }); + }; + + formDataRequest = async (request: Latest.FormDataRequest, parentKey: string): Promise => { + return { + ...request, + fields: await Promise.all( + request.fields.map((field) => this.visitor.FormDataField(field, `${parentKey}/field/${field.key}`)), + ), + }; + }; + + typeDefinition = async (type: Latest.TypeDefinition, parentKey: string): Promise => { + return { + ...type, + shape: await this.visitor.TypeShape(type.shape, `${parentKey}/shape`), + }; + }; +} diff --git a/packages/fdr-sdk/src/api-definition/typeid-visitor.ts b/packages/fdr-sdk/src/api-definition/typeid-visitor.ts new file mode 100644 index 0000000000..ae17094a7f --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/typeid-visitor.ts @@ -0,0 +1,148 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; +import { noop } from "ts-essentials"; +import type * as Latest from "./latest"; + +export class ApiTypeIdVisitor { + public static visitEndpointDefinition( + endpoint: Latest.EndpointDefinition, + visit: (typeId: Latest.TypeId) => void, + ): void { + endpoint.pathParameters?.forEach((pathParameter) => { + ApiTypeIdVisitor.visitTypeReference(pathParameter.valueShape, visit); + }); + endpoint.queryParameters?.forEach((queryParameter) => { + ApiTypeIdVisitor.visitTypeReference(queryParameter.valueShape, visit); + }); + endpoint.requestHeaders?.forEach((header) => { + ApiTypeIdVisitor.visitTypeReference(header.valueShape, visit); + }); + endpoint.responseHeaders?.forEach((header) => { + ApiTypeIdVisitor.visitTypeReference(header.valueShape, visit); + }); + if (endpoint.request?.body != null) { + ApiTypeIdVisitor.visitHttpRequestBodyShape(endpoint.request.body, visit); + } + if (endpoint.response?.body != null) { + ApiTypeIdVisitor.visitHttpResponseBodyShape(endpoint.response.body, visit); + } + + endpoint.errors?.forEach((error) => { + if (error.shape != null) { + ApiTypeIdVisitor.visitTypeShape(error.shape, visit); + } + }); + } + + public static visitWebSocketChannel( + channel: Latest.WebSocketChannel, + visit: (typeId: Latest.TypeId) => void, + ): void { + channel.requestHeaders?.forEach((header) => { + ApiTypeIdVisitor.visitTypeReference(header.valueShape, visit); + }); + channel.pathParameters?.forEach((pathParameter) => { + ApiTypeIdVisitor.visitTypeReference(pathParameter.valueShape, visit); + }); + channel.queryParameters?.forEach((queryParameter) => { + ApiTypeIdVisitor.visitTypeReference(queryParameter.valueShape, visit); + }); + channel.messages.forEach((message) => { + ApiTypeIdVisitor.visitTypeShape(message.body, visit); + }); + } + + public static visitWebhookDefinition( + webhook: Latest.WebhookDefinition, + visit: (typeId: Latest.TypeId) => void, + ): void { + webhook.headers?.forEach((header) => { + ApiTypeIdVisitor.visitTypeReference(header.valueShape, visit); + }); + if (webhook.payload) { + ApiTypeIdVisitor.visitTypeShape(webhook.payload.shape, visit); + } + } + + public static visitHttpRequestBodyShape( + bodyShape: Latest.HttpRequestBodyShape, + visit: (typeId: Latest.TypeId) => void, + ): void { + return visitDiscriminatedUnion(bodyShape)._visit({ + object: (value) => ApiTypeIdVisitor.visitObjectType(value, visit), + alias: (value) => ApiTypeIdVisitor.visitTypeReference(value.value, visit), + bytes: noop, + formData: (value) => ApiTypeIdVisitor.visitFormDataRequest(value, visit), + }); + } + + public static visitHttpResponseBodyShape( + bodyShape: Latest.HttpResponseBodyShape, + visit: (typeId: Latest.TypeId) => void, + ): void { + return visitDiscriminatedUnion(bodyShape)._visit({ + object: (value) => ApiTypeIdVisitor.visitObjectType(value, visit), + alias: (value) => ApiTypeIdVisitor.visitTypeReference(value.value, visit), + fileDownload: noop, + streamingText: noop, + stream: (value) => ApiTypeIdVisitor.visitTypeShape(value.shape, visit), + }); + } + + public static visitFormDataRequest( + typeDefinition: Latest.FormDataRequest, + visit: (typeId: Latest.TypeId) => void, + ): void { + return typeDefinition.fields.forEach((field) => + visitDiscriminatedUnion(field)._visit({ + file: noop, + files: noop, + property: (property) => ApiTypeIdVisitor.visitTypeReference(property.valueShape, visit), + }), + ); + } + + public static visitTypeDefinition( + typeDefinition: Latest.TypeDefinition, + visit: (typeId: Latest.TypeId) => void, + ): void { + return ApiTypeIdVisitor.visitTypeShape(typeDefinition.shape, visit); + } + + public static visitTypeShape(typeShape: Latest.TypeShape, visit: (typeId: Latest.TypeId) => void): void { + return visitDiscriminatedUnion(typeShape)._visit({ + object: (value) => ApiTypeIdVisitor.visitObjectType(value, visit), + alias: (value) => ApiTypeIdVisitor.visitTypeReference(value.value, visit), + enum: noop, + undiscriminatedUnion: (value) => + value.variants.forEach((variant) => ApiTypeIdVisitor.visitTypeReference(variant.shape, visit)), + discriminatedUnion: (value) => + value.variants.forEach((variant) => ApiTypeIdVisitor.visitObjectType(variant, visit)), + }); + } + + public static visitObjectType(typeShape: Latest.ObjectType, visit: (typeId: Latest.TypeId) => void): void { + typeShape.extends.forEach(visit); + typeShape.properties.forEach((property) => { + ApiTypeIdVisitor.visitTypeReference(property.valueShape, visit); + }); + } + + public static visitTypeReference( + typeReference: Latest.TypeReference, + visit: (typeId: Latest.TypeId) => void, + ): void { + return visitDiscriminatedUnion(typeReference)._visit({ + id: (value) => visit(value.id), + primitive: noop, + optional: (value) => ApiTypeIdVisitor.visitTypeReference(value.shape, visit), + list: (value) => ApiTypeIdVisitor.visitTypeReference(value.itemShape, visit), + set: (value) => ApiTypeIdVisitor.visitTypeReference(value.itemShape, visit), + map: (value) => { + ApiTypeIdVisitor.visitTypeReference(value.keyShape, visit); + ApiTypeIdVisitor.visitTypeReference(value.valueShape, visit); + }, + literal: noop, + unknown: noop, + }); + } +} diff --git a/packages/fdr-sdk/src/api-definition/types.ts b/packages/fdr-sdk/src/api-definition/types.ts new file mode 100644 index 0000000000..7f46f38271 --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/types.ts @@ -0,0 +1,10 @@ +import type * as Latest from "./latest"; + +export type TypeShapeOrReference = Latest.TypeShape | Latest.TypeReference; +export type DereferencedTypeShape = Exclude; +export type DereferencedTypeReference = Exclude; +export type DereferencedTypeShapeOrReference = DereferencedTypeShape | DereferencedTypeReference; +export type DereferencedNonOptionalTypeShapeOrReference = Exclude< + DereferencedTypeShapeOrReference, + Latest.TypeReference.Optional +>; diff --git a/packages/fdr-sdk/src/api-definition/unwrap.ts b/packages/fdr-sdk/src/api-definition/unwrap.ts new file mode 100644 index 0000000000..79d721ac9d --- /dev/null +++ b/packages/fdr-sdk/src/api-definition/unwrap.ts @@ -0,0 +1,292 @@ +import { isPlainObject } from "@fern-ui/core-utils"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; +import compact from "lodash-es/compact"; +import sortBy from "lodash-es/sortBy"; +import type * as FernDocs from "../docs"; +import { AvailabilityOrder, coalesceAvailability } from "./availability"; +import { LOOP_TOLERANCE } from "./const"; +import * as Latest from "./latest"; +import type { DereferencedNonOptionalTypeShapeOrReference, TypeShapeOrReference } from "./types"; + +export type UnwrappedReference = { + shape: DereferencedNonOptionalTypeShapeOrReference; + availability: Latest.Availability | undefined; + descriptions: FernDocs.MarkdownText[]; + isOptional: boolean; + default?: unknown; +}; + +export type UnwrappedObjectType = { + properties: Latest.ObjectProperty[]; + descriptions: FernDocs.MarkdownText[]; +}; + +type InternalDefaultValue = + | { type: "unknown"; value: unknown } + | { type: "typeReferenceId"; value: Latest.TypeReferenceIdDefault }; + +/** + * A TypeShape or TypeReference might be an alias or reference to another type. + * This function unwraps the reference, including any optional wrappers, to get the actual shape. + * + * When optionals are detected, attempt to find the default value for the shape. + * Since aliases can be recursive, the first default value found is returned, which can be contained in: + * - the optional wrapper + * - the type reference id + * - the primitive or literal shape itself + * + * @param typeRef to unwrap + * @param types from the API definition + * @returns UnwrappedReference containing the shape, whether it is optional, and the default value if it exists + */ +export function unwrapReference( + typeRef: TypeShapeOrReference, + types: Record, +): UnwrappedReference; +export function unwrapReference( + typeRef: TypeShapeOrReference | undefined, + types: Record, +): UnwrappedReference | undefined; +export function unwrapReference( + typeRef: TypeShapeOrReference | undefined, + types: Record, +): UnwrappedReference | undefined { + if (typeRef == null) { + return undefined; + } + + let isOptional = false; + const defaults: InternalDefaultValue[] = []; + const descriptions: FernDocs.MarkdownText[] = []; + const availabilities: Latest.Availability[] = []; + + let loop = 0; + while (typeRef != null) { + if (loop > LOOP_TOLERANCE) { + // eslint-disable-next-line no-console + console.error("Infinite loop detected while unwrapping type reference. Falling back to unknown type."); + typeRef = undefined; + break; + } + + if (typeRef.type === "optional") { + isOptional = true; + if (typeRef.default != null) { + defaults.push({ type: "unknown", value: typeRef.default }); + } + typeRef = typeRef.shape; + } else if (typeRef.type === "alias") { + typeRef = typeRef.value; + } else if (typeRef.type === "id") { + if (typeRef.default != null) { + defaults.push({ type: "typeReferenceId", value: typeRef.default }); + } + const typeDef: Latest.TypeDefinition | undefined = types[typeRef.id]; + if (typeDef != null) { + if (typeDef.availability) { + availabilities.push(typeDef.availability); + } + + typeRef = typeDef.shape; + if (typeDef.description != null) { + descriptions.push(typeDef.description); + } + } + } else { + break; + } + + loop++; + } + + if (typeRef == null) { + // Note: this should be a fatal error, but we're handling it gracefully for now + // eslint-disable-next-line no-console + console.error("Type reference is invalid. Falling back to unknown type."); + } + + return { + shape: typeRef ?? { type: "unknown", displayName: undefined }, + availability: coalesceAvailability(availabilities), + isOptional, + default: selectDefaultValue(typeRef, defaults), + descriptions, + }; +} + +function selectDefaultValue( + shape: DereferencedNonOptionalTypeShapeOrReference | undefined, + defaults: InternalDefaultValue[], +): unknown | undefined { + // If the shape is a literal, the default value will always be the literal value + if (shape?.type === "literal") { + return shape.value.value; + } + + const defaultValue = defaults.find((d) => { + // If the shape is unknown, we can't validate the default value, so we assume it's always the first one + if (shape == null) { + return true; + } + + // if a typeReferenceId is found, we need to validate that the default value is compatible with the shape + else if (d.type === "typeReferenceId") { + return visitDiscriminatedUnion(d.value)._visit({ + enum: () => shape?.type === "enum", + }); + } + + // TODO: validate that the default value is compatible with the shape + else { + return true; + } + }); + + if (defaultValue?.type === "unknown") { + return defaultValue.value; + } else if (defaultValue?.type === "typeReferenceId") { + return defaultValue.value.value; + } else if (shape?.type === "primitive") { + return primitiveToDefault(shape.value); + } else if (shape?.type === "enum") { + return shape.default; + } else { + return undefined; + } +} + +/** + * Dereferences extended objects and returns all properties of the object. + * If an object extends another object, the properties of the extended object will be sorted alphabetically. + * Additionally, required properties will come before optional properties. + * + * @param object to dereference + * @param types from the API definition + * @returns the properties of the object, including properties from extended objects + */ +export function unwrapObjectType( + object: Latest.ObjectType, + types: Record, +): UnwrappedObjectType { + const directProperties = object.properties; + const descriptions: FernDocs.MarkdownText[] = []; + const extendedProperties = object.extends.flatMap((typeId): Latest.ObjectProperty[] => { + const typeDef = types[typeId]; + if (typeDef?.description) { + descriptions.push(typeDef.description); + } + + const unwrapped = unwrapReference(typeDef?.shape, types); + unwrapped?.descriptions.forEach((description) => descriptions.push(description)); + + // TODO: should we be able to extend discriminated and undiscriminated unions? + if (unwrapped?.shape.type !== "object") { + // eslint-disable-next-line no-console + console.error("Object extends non-object", typeId); + return []; + } + const extended = unwrapObjectType(unwrapped.shape, types); + + // merge the availability of the extended object with the availability of the properties + extended.properties = extended.properties.map((property) => { + return { + ...property, + availability: coalesceAvailability( + compact([typeDef?.availability, unwrapped.availability, property.availability]), + ), + }; + }); + + descriptions.push(...extended.descriptions); + + if (!unwrapped.isOptional) { + return extended.properties; + } + + // if the extended object is optional, we need to make all properties optional + return extended.properties.map((property): Latest.ObjectProperty => { + // if a default value is present for the referenced object, we can find the default value for this property + const defaultProperty = isPlainObject(unwrapped.default) ? unwrapped.default[property.key] : undefined; + + const valueShape: Latest.TypeReference.Optional = + property.valueShape.type === "optional" + ? { ...property.valueShape, default: defaultProperty ?? property.valueShape.default } + : { type: "optional", shape: property.valueShape, default: defaultProperty }; + + return { + ...property, + valueShape, + }; + }); + }); + + // TODO: for extended properties, we should check for duplicates, and merge them if necessary + if (extendedProperties.length === 0) { + // if there are no extended properties, we can just return the direct properties + // required properties should come before optional properties + // however, we do NOT sort the properties by key because the initial order of properties may be significant + const properties = sortBy( + [...directProperties], + (property) => unwrapReference(property.valueShape, types)?.isOptional, + (property) => AvailabilityOrder.indexOf(property.availability ?? Latest.Availability.Stable), + ); + return { properties, descriptions }; + } + const propertyKeys = new Set(object.properties.map((property) => property.key)); + const filteredExtendedProperties = extendedProperties.filter( + (extendedProperty) => !propertyKeys.has(extendedProperty.key), + ); + + // required properties should come before optional properties + // since there are extended properties, the initial order of properties are not significant, and we should sort by key + const properties = sortBy( + [...directProperties, ...filteredExtendedProperties], + (property) => unwrapReference(property.valueShape, types)?.isOptional, + (property) => AvailabilityOrder.indexOf(property.availability ?? Latest.Availability.Stable), + (property) => property.key, + ); + return { properties, descriptions }; +} + +/** + * The discriminant of a discriminated union is converted to a literal type, *prepended* to the additional properties. + */ +export function unwrapDiscriminatedUnionVariant( + union: Latest.DiscriminatedUnionType, + variant: Latest.DiscriminatedUnionVariant, + types: Record, +): UnwrappedObjectType { + const { properties, descriptions } = unwrapObjectType(variant, types); + return { + properties: [ + { + key: union.discriminant, + valueShape: { type: "literal", value: { type: "stringLiteral", value: variant.discriminantValue } }, + + // the description and availability of the discriminant should not be included here + // because they are already included in the union variant itself + description: undefined, + availability: undefined, + }, + ...properties, + ], + descriptions, + }; +} + +function primitiveToDefault(shape: Latest.PrimitiveType): unknown | undefined { + return visitDiscriminatedUnion(shape, "type")._visit({ + string: (value) => value.default, + integer: (value) => value.default, + double: (value) => value.default, + uint: () => undefined, + uint64: () => undefined, + boolean: (value) => value.default, + long: (value) => value.default, + datetime: (datetime) => datetime.default, + uuid: (uuid) => uuid.default, + base64: (base64) => base64.default, + date: (value) => value.default, + bigInteger: (value) => value.default, + }); +} diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.ts index a661d94931..485c822d77 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.ts @@ -6,7 +6,8 @@ import * as FernRegistry from "../../../../../../../index"; export interface EndpointDefinition extends FernRegistry.api.latest.WithDescription, - FernRegistry.api.latest.WithAvailability { + FernRegistry.api.latest.WithAvailability, + FernRegistry.api.latest.WithNamespace { id: FernRegistry.EndpointId; method: FernRegistry.HttpMethod; path: FernRegistry.api.latest.PathPart[]; diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.ts index c0f38c6589..69ff5b3eec 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.ts @@ -5,13 +5,13 @@ import * as FernRegistry from "../../../../../../../index"; export interface ExampleEndpointCall extends FernRegistry.api.latest.WithDescription { - name: string | undefined; path: string; - pathParameters: Record; - queryParameters: Record; - headers: Record; - requestBody: FernRegistry.api.latest.ExampleEndpointRequest | undefined; responseStatusCode: number; + name: string | undefined; + pathParameters: Record | undefined; + queryParameters: Record | undefined; + headers: Record | undefined; + requestBody: FernRegistry.api.latest.ExampleEndpointRequest | undefined; responseBody: FernRegistry.api.latest.ExampleEndpointResponse | undefined; - snippets: FernRegistry.api.latest.CodeSnippet[]; + snippets: Record | undefined; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.ts index 3bb7b865ad..6b0d528d3a 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.ts @@ -6,7 +6,7 @@ import * as FernRegistry from "../../../../../../../index"; export type HttpRequestBodyShape = | FernRegistry.api.latest.HttpRequestBodyShape.Object_ - | FernRegistry.api.latest.HttpRequestBodyShape.Reference + | FernRegistry.api.latest.HttpRequestBodyShape.Alias | FernRegistry.api.latest.HttpRequestBodyShape.Bytes | FernRegistry.api.latest.HttpRequestBodyShape.FormData; @@ -15,8 +15,8 @@ export declare namespace HttpRequestBodyShape { type: "object"; } - interface Reference { - type: "reference"; + interface Alias { + type: "alias"; value: FernRegistry.api.latest.TypeReference; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.ts index 5debe8a9a5..732e122c6c 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.ts @@ -6,7 +6,7 @@ import * as FernRegistry from "../../../../../../../index"; export type HttpResponseBodyShape = | FernRegistry.api.latest.HttpResponseBodyShape.Object_ - | FernRegistry.api.latest.HttpResponseBodyShape.Reference + | FernRegistry.api.latest.HttpResponseBodyShape.Alias | FernRegistry.api.latest.HttpResponseBodyShape.FileDownload | FernRegistry.api.latest.HttpResponseBodyShape.StreamingText | FernRegistry.api.latest.HttpResponseBodyShape.Stream; @@ -16,8 +16,8 @@ export declare namespace HttpResponseBodyShape { type: "object"; } - interface Reference { - type: "reference"; + interface Alias { + type: "alias"; value: FernRegistry.api.latest.TypeReference; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.ts index 9c0a7939e2..da50ce2615 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.ts @@ -5,6 +5,6 @@ import * as FernRegistry from "../../../../../../../index"; export interface DiscriminatedUnionType { - discriminant: string; + discriminant: FernRegistry.PropertyKey; variants: FernRegistry.api.latest.DiscriminatedUnionVariant[]; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.ts index 0651fdbe05..2790951047 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.ts @@ -6,8 +6,8 @@ import * as FernRegistry from "../../../../../../../index"; export interface DiscriminatedUnionVariant extends FernRegistry.api.latest.WithDescription, - FernRegistry.api.latest.WithAvailability { + FernRegistry.api.latest.WithAvailability, + FernRegistry.api.latest.ObjectType { discriminantValue: string; displayName: string | undefined; - additionalProperties: FernRegistry.api.latest.ObjectType; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.ts index 01dc7d5840..8e8a8d7ed0 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.ts @@ -7,6 +7,5 @@ import * as FernRegistry from "../../../../../../../index"; export interface FormDataRequest extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability { - name: string; fields: FernRegistry.api.latest.FormDataField[]; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.ts index f2b1849180..52e57a8d03 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.ts @@ -6,11 +6,12 @@ import * as FernRegistry from "../../../../../../../index"; export interface WebhookDefinition extends FernRegistry.api.latest.WithDescription, - FernRegistry.api.latest.WithAvailability { + FernRegistry.api.latest.WithAvailability, + FernRegistry.api.latest.WithNamespace { id: FernRegistry.WebhookId; method: FernRegistry.api.latest.WebhookHttpMethod; path: string[]; - headers: FernRegistry.api.latest.ObjectProperty[]; - payload: FernRegistry.api.latest.WebhookPayload; - examples: FernRegistry.api.v1.read.ExampleWebhookPayload[]; + headers: FernRegistry.api.latest.ObjectProperty[] | undefined; + payload: FernRegistry.api.latest.WebhookPayload | undefined; + examples: FernRegistry.api.v1.read.ExampleWebhookPayload[] | undefined; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.ts index b9aea9e6c6..8447957fbe 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.ts @@ -5,10 +5,10 @@ import * as FernRegistry from "../../../../../../../index"; export interface ExampleWebSocketSession extends FernRegistry.api.latest.WithDescription { - name: string | undefined; path: string; - pathParameters: Record; - queryParameters: Record; - requestHeaders: Record; - messages: FernRegistry.api.latest.ExampleWebSocketMessage[]; + name: string | undefined; + pathParameters: Record | undefined; + queryParameters: Record | undefined; + requestHeaders: Record | undefined; + messages: FernRegistry.api.latest.ExampleWebSocketMessage[] | undefined; } diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.ts index a713892406..e69d85e01e 100644 --- a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.ts +++ b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.ts @@ -6,7 +6,8 @@ import * as FernRegistry from "../../../../../../../index"; export interface WebSocketChannel extends FernRegistry.api.latest.WithDescription, - FernRegistry.api.latest.WithAvailability { + FernRegistry.api.latest.WithAvailability, + FernRegistry.api.latest.WithNamespace { id: FernRegistry.WebSocketId; path: FernRegistry.api.latest.PathPart[]; /** The messages that can be sent and received on this channel */ diff --git a/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts b/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts index 1c96fc9cd0..88ab696ec1 100644 --- a/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts +++ b/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts @@ -1,7 +1,8 @@ +import assertNever from "@fern-ui/core-utils/assertNever"; +import titleCase from "@fern-ui/core-utils/titleCase"; import isEqual from "fast-deep-equal"; import { APIV1Db, APIV1Read, APIV1Write, FdrAPI } from "../../client"; -import { kebabCase, titleCase } from "../../utils"; -import { assertNever } from "../utils/assertNever"; +import { kebabCase } from "../../utils"; import { generateEndpointErrorExample, generateEndpointNonStreamResponseExample, diff --git a/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts b/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts index 72f548f789..11fdae4a4d 100644 --- a/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts +++ b/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts @@ -1,3 +1,4 @@ +import assertNever from "@fern-ui/core-utils/assertNever"; import { DocsV1Db, DocsV1Read, @@ -10,7 +11,6 @@ import { } from "../../client"; import { isNavigationTabLink } from "../../client/visitNavigationTab"; import { kebabCase } from "../../utils"; -import { assertNever } from "../utils/assertNever"; import { DEFAULT_DARK_MODE_ACCENT_PRIMARY, DEFAULT_LIGHT_MODE_ACCENT_PRIMARY } from "../utils/colors"; export interface S3FileInfo { diff --git a/packages/fdr-sdk/src/converters/db/examples/generateEndpointExampleCall.ts b/packages/fdr-sdk/src/converters/db/examples/generateEndpointExampleCall.ts index d78bf81c4a..bac770054a 100644 --- a/packages/fdr-sdk/src/converters/db/examples/generateEndpointExampleCall.ts +++ b/packages/fdr-sdk/src/converters/db/examples/generateEndpointExampleCall.ts @@ -1,5 +1,5 @@ +import assertNever from "@fern-ui/core-utils/assertNever"; import { APIV1Write } from "../../../client"; -import { assertNever } from "../../utils/assertNever"; import { generateExampleFromTypeReference, generateExampleFromTypeShape, diff --git a/packages/fdr-sdk/src/converters/db/examples/generateHttpBodyExample.ts b/packages/fdr-sdk/src/converters/db/examples/generateHttpBodyExample.ts index 1ba1ce0955..9d4d6d8bc0 100644 --- a/packages/fdr-sdk/src/converters/db/examples/generateHttpBodyExample.ts +++ b/packages/fdr-sdk/src/converters/db/examples/generateHttpBodyExample.ts @@ -1,5 +1,5 @@ +import assertNever from "@fern-ui/core-utils/assertNever"; import { APIV1Write } from "../../../client"; -import { assertNever } from "../../utils/assertNever"; export type ResolveTypeById = (typeId: APIV1Write.TypeId) => APIV1Write.TypeDefinition; diff --git a/packages/fdr-sdk/src/converters/db/upgrade/migrateDocsDbDefinition.ts b/packages/fdr-sdk/src/converters/db/upgrade/migrateDocsDbDefinition.ts index 0e5dac153d..e3e474ebf7 100644 --- a/packages/fdr-sdk/src/converters/db/upgrade/migrateDocsDbDefinition.ts +++ b/packages/fdr-sdk/src/converters/db/upgrade/migrateDocsDbDefinition.ts @@ -1,5 +1,5 @@ +import isPlainObject from "@fern-ui/core-utils/isPlainObject"; import { DocsV1Db } from "../../../client"; -import { isPlainObject } from "../../../utils"; import { upgradeV1ToV2 } from "./upgradeV1ToV2"; import { upgradeV2ToV3 } from "./upgradeV2ToV3"; diff --git a/packages/fdr-sdk/src/converters/read/convertDbAPIDefinitionToRead.ts b/packages/fdr-sdk/src/converters/read/convertDbAPIDefinitionToRead.ts index 2df4e77717..7f192ce4dd 100644 --- a/packages/fdr-sdk/src/converters/read/convertDbAPIDefinitionToRead.ts +++ b/packages/fdr-sdk/src/converters/read/convertDbAPIDefinitionToRead.ts @@ -1,5 +1,5 @@ +import assertNever from "@fern-ui/core-utils/assertNever"; import { APIV1Db, APIV1Read } from "../../client"; -import { assertNever } from "../utils/assertNever"; export function convertDbAPIDefinitionsToRead(dbApiDefinitions: Record) { return Object.fromEntries( diff --git a/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts b/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts index d856d3079c..153592d811 100644 --- a/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts +++ b/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts @@ -1,8 +1,8 @@ +import assertNever from "@fern-ui/core-utils/assertNever"; import tinycolor from "tinycolor2"; import { DocsV1Db, DocsV1Read, visitDbNavigationConfig, visitUnversionedDbNavigationConfig } from "../../client"; import { visitDbNavigationTab } from "../../client/visitNavigationTab"; import { kebabCase } from "../../utils"; -import { assertNever } from "../utils/assertNever"; import { DEFAULT_DARK_MODE_ACCENT_PRIMARY, DEFAULT_LIGHT_MODE_ACCENT_PRIMARY } from "../utils/colors"; export function convertDbDocsConfigToRead({ dbShape }: { dbShape: DocsV1Db.DocsDbConfig }): DocsV1Read.DocsConfig { diff --git a/packages/fdr-sdk/src/converters/utils/assertNever.ts b/packages/fdr-sdk/src/converters/utils/assertNever.ts deleted file mode 100644 index e96382acf1..0000000000 --- a/packages/fdr-sdk/src/converters/utils/assertNever.ts +++ /dev/null @@ -1,6 +0,0 @@ -export function assertNever(x: never): never { - throw new Error("Unexpected value: " + JSON.stringify(x)); -} - -// eslint-disable-next-line @typescript-eslint/no-empty-function -export function assertNeverNoThrow(_: never): void {} diff --git a/packages/fdr-sdk/src/index.ts b/packages/fdr-sdk/src/index.ts index 29f737f110..13caa769f4 100644 --- a/packages/fdr-sdk/src/index.ts +++ b/packages/fdr-sdk/src/index.ts @@ -3,5 +3,3 @@ export * from "./converters"; export * as FernNavigation from "./navigation"; export { kebabCase } from "./utils/lodash"; export { default as once } from "./utils/lodash/once"; -export * from "./utils/titleCase"; -export * from "./utils/visitDiscriminatedUnion"; diff --git a/packages/fdr-sdk/src/navigation/ApiTypeIdVisitor.ts b/packages/fdr-sdk/src/navigation/ApiTypeIdVisitor.ts index 3bd532e873..210d3cd757 100644 --- a/packages/fdr-sdk/src/navigation/ApiTypeIdVisitor.ts +++ b/packages/fdr-sdk/src/navigation/ApiTypeIdVisitor.ts @@ -1,6 +1,6 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { noop } from "ts-essentials"; import type { APIV1Read } from "../client/types"; -import { visitDiscriminatedUnion } from "../utils/visitDiscriminatedUnion"; export class ApiTypeIdVisitor { public static visitEndpointDefinition( diff --git a/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts b/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts index dace587a08..a8596e4089 100644 --- a/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts +++ b/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts @@ -1,5 +1,6 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { UnreachableCaseError } from "ts-essentials"; -import { FernNavigation, visitDiscriminatedUnion } from "../.."; +import { FernNavigation } from "../.."; /** * This migration accounts for the following changes: diff --git a/packages/fdr-sdk/src/navigation/utils/createBreadcrumbs.ts b/packages/fdr-sdk/src/navigation/utils/createBreadcrumbs.ts index c38f20e18e..1f2c9b6577 100644 --- a/packages/fdr-sdk/src/navigation/utils/createBreadcrumbs.ts +++ b/packages/fdr-sdk/src/navigation/utils/createBreadcrumbs.ts @@ -1,6 +1,6 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { noop } from "ts-essentials"; import { FernNavigation } from "../.."; -import { visitDiscriminatedUnion } from "../../utils"; export function createBreadcrumbs(nodes: FernNavigation.NavigationNode[]): FernNavigation.BreadcrumbItem[] { const breadcrumb: FernNavigation.BreadcrumbItem[] = []; diff --git a/packages/fdr-sdk/src/navigation/utils/getApiReferenceId.ts b/packages/fdr-sdk/src/navigation/utils/getApiReferenceId.ts index feead390a9..49ec1ca9f7 100644 --- a/packages/fdr-sdk/src/navigation/utils/getApiReferenceId.ts +++ b/packages/fdr-sdk/src/navigation/utils/getApiReferenceId.ts @@ -1,5 +1,5 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { FernNavigation } from "../.."; -import { visitDiscriminatedUnion } from "../../utils"; const RETURN_UNDEFINED = () => undefined; const RETURN_API_DEFINITION_ID = (node: FernNavigation.WithApiDefinitionId) => node.apiDefinitionId; diff --git a/packages/fdr-sdk/src/navigation/versions/latest/getPageId.ts b/packages/fdr-sdk/src/navigation/versions/latest/getPageId.ts index 9d691f60e3..859a55579d 100644 --- a/packages/fdr-sdk/src/navigation/versions/latest/getPageId.ts +++ b/packages/fdr-sdk/src/navigation/versions/latest/getPageId.ts @@ -1,5 +1,5 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import type { NavigationNodePage, PageId } from "."; -import { visitDiscriminatedUnion } from "../../../utils"; const RETURN_PAGEID = (node: { pageId: PageId }) => node.pageId; const RETURN_OVERVIEW_PAGEID = (node: { overviewPageId?: PageId }) => node.overviewPageId; diff --git a/packages/fdr-sdk/src/navigation/versions/latest/traverseNavigation.ts b/packages/fdr-sdk/src/navigation/versions/latest/traverseNavigation.ts index 920827efd0..4a5c965e14 100644 --- a/packages/fdr-sdk/src/navigation/versions/latest/traverseNavigation.ts +++ b/packages/fdr-sdk/src/navigation/versions/latest/traverseNavigation.ts @@ -1,5 +1,5 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { noop } from "ts-essentials"; -import { visitDiscriminatedUnion } from "../../../utils"; import { NavigationNode } from "./NavigationNode"; const SKIP = "skip" as const; diff --git a/packages/fdr-sdk/src/navigation/versions/v1/converters/ApiReferenceNavigationConverter.ts b/packages/fdr-sdk/src/navigation/versions/v1/converters/ApiReferenceNavigationConverter.ts index b40c754a1e..d4bff41a4e 100644 --- a/packages/fdr-sdk/src/navigation/versions/v1/converters/ApiReferenceNavigationConverter.ts +++ b/packages/fdr-sdk/src/navigation/versions/v1/converters/ApiReferenceNavigationConverter.ts @@ -1,8 +1,9 @@ +import titleCase from "@fern-ui/core-utils/titleCase"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { noop } from "ts-essentials"; import urljoin from "url-join"; import { FernNavigation } from "../../../.."; import { APIV1Read, DocsV1Read } from "../../../../client/types"; -import { titleCase, visitDiscriminatedUnion } from "../../../../utils"; import { ApiDefinitionHolder } from "../../../ApiDefinitionHolder"; import { ROOT_PACKAGE_ID } from "../../../consts"; import { isSubpackage } from "../../../utils/isSubpackage"; diff --git a/packages/fdr-sdk/src/navigation/versions/v1/converters/NavigationConfigConverter.ts b/packages/fdr-sdk/src/navigation/versions/v1/converters/NavigationConfigConverter.ts index 84cbc72bbc..fed94ae4f0 100644 --- a/packages/fdr-sdk/src/navigation/versions/v1/converters/NavigationConfigConverter.ts +++ b/packages/fdr-sdk/src/navigation/versions/v1/converters/NavigationConfigConverter.ts @@ -1,10 +1,12 @@ +import assertNever from "@fern-ui/core-utils/assertNever"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { FernNavigation } from "../../../.."; import type { APIV1Read, DocsV1Read } from "../../../../client/types"; import { visitReadNavigationConfig, visitUnversionedReadNavigationConfig, } from "../../../../client/visitReadNavigationConfig"; -import { assertNever, kebabCase, visitDiscriminatedUnion } from "../../../../utils"; +import { kebabCase } from "../../../../utils"; import { ApiReferenceNavigationConverter } from "./ApiReferenceNavigationConverter"; import { ChangelogNavigationConverter } from "./ChangelogConverter"; import { NodeIdGenerator } from "./NodeIdGenerator"; diff --git a/packages/fdr-sdk/src/navigation/versions/v1/followRedirect.ts b/packages/fdr-sdk/src/navigation/versions/v1/followRedirect.ts index e91fc1352b..0204b3c9db 100644 --- a/packages/fdr-sdk/src/navigation/versions/v1/followRedirect.ts +++ b/packages/fdr-sdk/src/navigation/versions/v1/followRedirect.ts @@ -1,5 +1,5 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { FernNavigation } from "../../.."; -import { visitDiscriminatedUnion } from "../../../utils"; import { hasMetadata } from "./NavigationNodeWithMetadata"; export function followRedirect( diff --git a/packages/fdr-sdk/src/navigation/versions/v1/getPageId.ts b/packages/fdr-sdk/src/navigation/versions/v1/getPageId.ts index 9d691f60e3..859a55579d 100644 --- a/packages/fdr-sdk/src/navigation/versions/v1/getPageId.ts +++ b/packages/fdr-sdk/src/navigation/versions/v1/getPageId.ts @@ -1,5 +1,5 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import type { NavigationNodePage, PageId } from "."; -import { visitDiscriminatedUnion } from "../../../utils"; const RETURN_PAGEID = (node: { pageId: PageId }) => node.pageId; const RETURN_OVERVIEW_PAGEID = (node: { overviewPageId?: PageId }) => node.overviewPageId; diff --git a/packages/fdr-sdk/src/navigation/versions/v1/traverseNavigation.ts b/packages/fdr-sdk/src/navigation/versions/v1/traverseNavigation.ts index 920827efd0..4a5c965e14 100644 --- a/packages/fdr-sdk/src/navigation/versions/v1/traverseNavigation.ts +++ b/packages/fdr-sdk/src/navigation/versions/v1/traverseNavigation.ts @@ -1,5 +1,5 @@ +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { noop } from "ts-essentials"; -import { visitDiscriminatedUnion } from "../../../utils"; import { NavigationNode } from "./NavigationNode"; const SKIP = "skip" as const; diff --git a/packages/fdr-sdk/src/utils/assertNever.ts b/packages/fdr-sdk/src/utils/assertNever.ts deleted file mode 100644 index e96382acf1..0000000000 --- a/packages/fdr-sdk/src/utils/assertNever.ts +++ /dev/null @@ -1,6 +0,0 @@ -export function assertNever(x: never): never { - throw new Error("Unexpected value: " + JSON.stringify(x)); -} - -// eslint-disable-next-line @typescript-eslint/no-empty-function -export function assertNeverNoThrow(_: never): void {} diff --git a/packages/fdr-sdk/src/utils/index.ts b/packages/fdr-sdk/src/utils/index.ts index b2a5f8b14a..d8880050d7 100644 --- a/packages/fdr-sdk/src/utils/index.ts +++ b/packages/fdr-sdk/src/utils/index.ts @@ -1,5 +1 @@ -export * from "./assertNever"; -export * from "./isPlainObject"; export * from "./lodash"; -export * from "./titleCase"; -export * from "./visitDiscriminatedUnion"; diff --git a/packages/fdr-sdk/src/utils/isPlainObject.ts b/packages/fdr-sdk/src/utils/isPlainObject.ts deleted file mode 100644 index 96272f18e1..0000000000 --- a/packages/fdr-sdk/src/utils/isPlainObject.ts +++ /dev/null @@ -1,18 +0,0 @@ -// https://github.com/lodash/lodash/blob/master/isPlainObject.js -export function isPlainObject(value: unknown): value is Record { - if (!isObjectLike(value) || String(value) !== "[object Object]") { - return false; - } - if (Object.getPrototypeOf(value) == null) { - return true; - } - let proto = value; - while (Object.getPrototypeOf(proto) != null) { - proto = Object.getPrototypeOf(proto); - } - return Object.getPrototypeOf(value) === proto; -} - -function isObjectLike(value: unknown) { - return typeof value === "object" && value != null; -} diff --git a/packages/fdr-sdk/src/utils/specialTokens.ts b/packages/fdr-sdk/src/utils/specialTokens.ts deleted file mode 100644 index e5f69d47da..0000000000 --- a/packages/fdr-sdk/src/utils/specialTokens.ts +++ /dev/null @@ -1,361 +0,0 @@ -export const SPECIAL_TOKENS = [ - // privacy - "PII", - "PHI", - "PCI", - "GDPR", - "CCPA", - "HIPAA", - "COPPA", - "FERPA", - "GLBA", - "SOX", - "FISMA", - "NIST", - "CIS", - "ISO", - "IEC", - "ITAR", - "EAR", - "CMMC", - "CUI", - "CDI", - "FTC", - "FCC", - "SEC", - "FINRA", - - // security - "XSS", - "CSRF", - "SSRF", - "XSRF", - "TLS", - "SSL", - "SSH", - "API", - "OAuth", - "OAuth1", - "OAuth1.0", - "OAuth2", - "OAuth2.0", - "SAML", - "OpenID", - "OpenID Connect", - "CAPTCHA", - "reCAPTCHA", - "2FA", - "MFA", - "OTP", - "TOTP", - "HOTP", - "U2F", - "FIDO", - "FIDO2", - "PKI", - "HMAC", - "AES", - "RSA", - "SHA", - "MD5", - "BCrypt", - "PBKDF2", - "Argon2", - "SCrypt", - "JWT", - "JWE", - "JWS", - "JWK", - "JWA", - "JOSE", - - // shopping - "SKU", - "SKUs", - "UPC", - "EAN", - "ISBN", - "ASIN", - "MPN", - "MSRP", - "MAP", - "RRP", - "MSRP", - - // time - "AM", - "PM", - "UTC", - "GMT", - "PST", - "PDT", - "EST", - "EDT", - "CST", - "CDT", - "MST", - "MDT", - - // geography - "USA", - "UK", - "EU", - "UAE", - "APAC", - "EMEA", - "LATAM", - "ANZ", - "SEA", - "MEA", - "MENA", - "NATO", - "NA", - "SA", - "CA", - "EU", - "AU", - "NZ", - "JP", - "KR", - "CN", - "HK", - "TW", - "SG", - "MY", - "TH", - "ID", - "PH", - "VN", - "IN", - "PK", - "BD", - "LK", - "NP", - "MM", - "KH", - "LA", - "MM", - "BT", - "MV", - - // finance - "USD", - "EUR", - "GBP", - "JPY", - "CNY", - "RUB", - "INR", - "AUD", - "CAD", - "CHF", - "SGD", - "MYR", - "THB", - "IDR", - "KRW", - "PHP", - "VND", - "HKD", - "TWD", - "MXN", - "BRL", - "ARS", - "CLP", - "COP", - "PEN", - "ZAR", - "NGN", - "EGP", - "AED", - "SAR", - "ILS", - "TRY", - "SEK", - "NOK", - "DKK", - "ISK", - "HUF", - "PLN", - "CZK", - "RON", - "BGN", - - // programming - "API", - "APIs", - "SDK", - "SDKs", - "AI", - "OCR", - "REST", - "SOAP", - "JSON", - "XML", - "HTTP", - "HTTPS", - "URI", - "URL", - "CRUD", - "RESTful", - "KYB", - "KYC", - "AML", - "HTML", - "CSS", - "JS", - "SQL", - "DB", - "UI", - "UX", - "SaaS", - "PaaS", - "IaaS", - "IP", - "TCP", - "UDP", - "DNS", - "FTP", - "SMTP", - "IMAP", - "POP3", - "CSV", - "MVC", - "MVP", - "MVVM", - "DOM", - "SPA", - "SSR", - "CSR", - "DDoS", - "CDN", - "IoT", - "ML", - "DL", - "NLP", - "CLI", - "GUI", - "BI", - "ETL", - "RDBMS", - "NoSQL", - "IDE", - "CMS", - "CCPA", - "POSIX", - "ABI", - "API", - "AST", - "COBOL", - "DDL", - "DML", - - // AI-related - "NN", // Neural Network - "CNN", // Convolutional Neural Network - "RNN", // Recurrent Neural Network - "LSTM", // Long Short Term Memory - "GRU", // Gated Recurrent Unit - "ANN", // Artificial Neural Network - "GAN", // Generative Adversarial Network - "RL", // Reinforcement Learning - "DL", // Deep Learning - "ML", // Machine Learning - "NLP", // Natural Language Processing - "NLG", // Natural Language Generation - "NLU", // Natural Language Understanding - "BERT", // Bidirectional Encoder Representations from Transformers - "GPT", // Generative Pre-training Transformer - "SVM", // Support Vector Machine - "PCA", // Principal Component Analysis - "AI", // Artificial Intelligence - "CV", // Computer Vision - "TF", // TensorFlow - "TTS", // Text-to-Speech - "ASR", // Automatic Speech Recognition - "HMM", // Hidden Markov Model - "DNN", // Deep Neural Network - "MLP", // Multi-Layer Perceptron - "RBM", // Restricted Boltzmann Machine - "CRF", // Conditional Random Field - - // Media - "PDF", - "PDFs", - "RTF", - "TXT", - "XLS", - "XLSX", - "PPT", - - // Image - "JPG", - "JPEG", - "PNG", - "GIF", - "GIFs", - "SVG", - "TIFF", - "BMP", - "ICO", - "PSD", - "WebP", - "AVIF", - "HEIF", - "HEIC", - "EPS", - - // Audio - "MP3", - "WAV", - "AIFF", - "FLAC", - "WMA", - "AAC", - "OGG", - - // Video - "AVI", - "WMV", - "MOV", - "M4V", - "MP4", - "MPG", - "MPEG", - "FLV", - "SWF", - "MKV", - "WebM", - - // Cloud Computing - "GCP", // Google Cloud Platform - "AWS", // Amazon Web Services - "VM", // Virtual Machines - "VPC", // Virtual Private Cloud - "S3", // AWS Simple Storage Service - "EC2", // AWS Elastic Compute Cloud - - // Data Storage and Databases - "DynamoDB", - "CosmosDB", - "BigQuery", - "CI/CD", - - // Security and Compliance - "SOC1", // Service Organization Control 1 - "SOC2", // Service Organization Control 2 - "SOC3", // Service Organization Control 3 - "PCI DSS", // Payment Card Industry Data Security Standard - "WAF", // Web Application Firewall - "IAM", // Identity and Access Management - - // Networking - "SDN", // Software-Defined Networking - "MPLS", // Multi-Protocol Label Switching - "BGP", // Border Gateway Protocol - - // Frameworks and Libraries - "Vue.js", - "Node.js", - ".NET", -]; diff --git a/packages/fdr-sdk/src/utils/titleCase.ts b/packages/fdr-sdk/src/utils/titleCase.ts deleted file mode 100644 index d2b047ed59..0000000000 --- a/packages/fdr-sdk/src/utils/titleCase.ts +++ /dev/null @@ -1,19 +0,0 @@ -import title from "title"; -import { SPECIAL_TOKENS } from "./specialTokens"; - -export function titleCase(name: string): string { - // regex match pascalCase or CamelCase and add spaces between words - name = name.replace(/([a-z])([A-Z])/g, "$1 $2"); - - // regex match snake_case and replace "_" with " " - name = name.replace(/_/g, " "); - - // regex match kebab-case and replace "-" with " " - name = name.replace(/-/g, " "); - - const titleCased = title(name, { special: SPECIAL_TOKENS }); - - // regex match "V 2", "V 4", etc. and replace it with "V2", "V4", etc. - const versionedTitle = titleCased.replace(/V\s(\d)/g, "V$1"); - return versionedTitle; -} diff --git a/packages/fdr-sdk/src/utils/visitDiscriminatedUnion.ts b/packages/fdr-sdk/src/utils/visitDiscriminatedUnion.ts deleted file mode 100644 index c36b74250c..0000000000 --- a/packages/fdr-sdk/src/utils/visitDiscriminatedUnion.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { assertNever } from "./assertNever"; - -export type DiscriminatedUnionVisitor, U, Discriminant extends string> = { - [D in T[Discriminant]]: (value: Extract>) => U; -} & { - _other?: (value: Record) => U; -}; - -export function visitDiscriminatedUnion>( - item: T, -): { _visit: (visitor: DiscriminatedUnionVisitor) => U }; -export function visitDiscriminatedUnion, Discriminant extends string>( - item: T, - discriminant: Discriminant, -): { _visit: (visitor: DiscriminatedUnionVisitor) => U }; -export function visitDiscriminatedUnion, Discriminant extends string>( - item: T, - discriminant: Discriminant = "type" as Discriminant, -): { _visit: (visitor: DiscriminatedUnionVisitor) => U } { - return { - _visit: (visitor) => { - const visit = visitor[item[discriminant]]; - if (visit != null) { - return visit(item as Extract>); - } else { - if (visitor._other == null) { - assertNever(item as never); - } - return visitor._other(item); - } - }, - }; -} diff --git a/packages/fdr-sdk/tsconfig.json b/packages/fdr-sdk/tsconfig.json index 1c3797424f..a987228090 100644 --- a/packages/fdr-sdk/tsconfig.json +++ b/packages/fdr-sdk/tsconfig.json @@ -7,5 +7,6 @@ "lib": ["DOM", "ESNext"] }, "include": ["./src/**/*"], - "exclude": ["node_modules"] + "exclude": ["node_modules"], + "references": [{ "path": "../commons/core-utils" }] } diff --git a/packages/ui/app/src/api-reference/examples/__test__/stringifyHttpRequestExampleToCurl.test.ts b/packages/ui/app/src/api-reference/examples/__test__/stringifyHttpRequestExampleToCurl.test.ts index 9a2dbe71de..7ddc4b6764 100644 --- a/packages/ui/app/src/api-reference/examples/__test__/stringifyHttpRequestExampleToCurl.test.ts +++ b/packages/ui/app/src/api-reference/examples/__test__/stringifyHttpRequestExampleToCurl.test.ts @@ -1,10 +1,11 @@ +import { APIV1Read } from "@fern-api/fdr-sdk"; import * as FernNavigation from "@fern-api/fdr-sdk/navigation"; import { ResolvedEndpointDefinition } from "../../../resolver/types"; import { convertEndpointExampleToHttpRequestExample } from "../HttpRequestExample"; import { stringifyHttpRequestExampleToCurl } from "../stringifyHttpRequestExampleToCurl"; const MOCK_ENV = { - id: "", + id: FernNavigation.EnvironmentId(""), baseUrl: "https://api.example.com", }; @@ -12,13 +13,13 @@ const MOCK_ENDPOINT: ResolvedEndpointDefinition = { type: "endpoint", breadcrumb: [], nodeId: FernNavigation.NodeId(""), - id: "", + id: FernNavigation.EndpointId(""), // apiPackageId: "", slug: FernNavigation.Slug(""), auth: undefined, availability: undefined, defaultEnvironment: MOCK_ENV, - apiDefinitionId: "", + apiDefinitionId: FernNavigation.ApiDefinitionId(""), environments: [MOCK_ENV], method: "GET", title: "", @@ -35,14 +36,26 @@ const MOCK_ENDPOINT: ResolvedEndpointDefinition = { stream: undefined, }; -const EMPTY_EXAMPLE = { +const EMPTY_EXAMPLE: APIV1Read.ExampleEndpointCall = { pathParameters: {}, queryParameters: {}, headers: {}, path: "/api", responseStatusCode: 0, - codeExamples: {}, + codeExamples: { + nodeAxios: undefined, + pythonSdk: undefined, + typescriptSdk: undefined, + goSdk: undefined, + rubySdk: undefined, + }, codeSamples: [], + name: undefined, + requestBody: undefined, + requestBodyV3: undefined, + responseBody: undefined, + responseBodyV3: undefined, + description: undefined, }; function stringifyMockEndpoint(overrides: Partial = {}): string { @@ -53,12 +66,18 @@ function stringifyMockEndpoint(overrides: Partial = describe("stringifyHttpRequestExampleToCurl", () => { it("should render header authorization", () => { - expect(stringifyMockEndpoint({ auth: { type: "header", headerWireValue: "Authorization" } })).toMatchSnapshot(); + expect( + stringifyMockEndpoint({ + auth: { type: "header", headerWireValue: "Authorization", nameOverride: undefined, prefix: undefined }, + }), + ).toMatchSnapshot(); }); it("should render header authorization with prefix", () => { expect( - stringifyMockEndpoint({ auth: { type: "header", headerWireValue: "Authorization", prefix: "Token" } }), + stringifyMockEndpoint({ + auth: { type: "header", headerWireValue: "Authorization", prefix: "Token", nameOverride: undefined }, + }), ).toMatchSnapshot(); }); @@ -71,7 +90,7 @@ describe("stringifyHttpRequestExampleToCurl", () => { }); it("should render bearer authorization", () => { - expect(stringifyMockEndpoint({ auth: { type: "bearerAuth" } })).toMatchSnapshot(); + expect(stringifyMockEndpoint({ auth: { type: "bearerAuth", tokenName: undefined } })).toMatchSnapshot(); }); it("should render bearer authorization with custom token name", () => { @@ -79,6 +98,8 @@ describe("stringifyHttpRequestExampleToCurl", () => { }); it("should render basic authorization", () => { - expect(stringifyMockEndpoint({ auth: { type: "basicAuth" } })).toMatchSnapshot(); + expect( + stringifyMockEndpoint({ auth: { type: "basicAuth", usernameName: undefined, passwordName: undefined } }), + ).toMatchSnapshot(); }); }); diff --git a/packages/ui/app/src/hooks/usePlaygroundSettings.ts b/packages/ui/app/src/hooks/usePlaygroundSettings.ts index d515d806bf..a6a3a73ceb 100644 --- a/packages/ui/app/src/hooks/usePlaygroundSettings.ts +++ b/packages/ui/app/src/hooks/usePlaygroundSettings.ts @@ -1,5 +1,5 @@ -import { visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; import { NavigationNode, NodeId, PlaygroundSettings } from "@fern-api/fdr-sdk/navigation"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { useIsPlaygroundOpen, useNavigationNodes, usePlaygroundNodeId } from "../atoms"; export function usePlaygroundSettings(currentNodeId?: NodeId): PlaygroundSettings | undefined { diff --git a/packages/ui/app/src/playground/endpoint/PlaygroundEndpointForm.tsx b/packages/ui/app/src/playground/endpoint/PlaygroundEndpointForm.tsx index 27f28bded8..f15adefa79 100644 --- a/packages/ui/app/src/playground/endpoint/PlaygroundEndpointForm.tsx +++ b/packages/ui/app/src/playground/endpoint/PlaygroundEndpointForm.tsx @@ -1,4 +1,4 @@ -import { titleCase } from "@fern-api/fdr-sdk"; +import titleCase from "@fern-ui/core-utils/titleCase"; import { Dispatch, FC, SetStateAction, useCallback } from "react"; import { ResolvedEndpointDefinition, diff --git a/packages/ui/app/src/playground/endpoint/PlaygroundEndpointMultipartForm.tsx b/packages/ui/app/src/playground/endpoint/PlaygroundEndpointMultipartForm.tsx index 8c5e5a2b30..e6fae0152e 100644 --- a/packages/ui/app/src/playground/endpoint/PlaygroundEndpointMultipartForm.tsx +++ b/packages/ui/app/src/playground/endpoint/PlaygroundEndpointMultipartForm.tsx @@ -1,9 +1,9 @@ -import { visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; import { ReactElement, useCallback } from "react"; import { ResolvedEndpointDefinition, ResolvedFormData, ResolvedTypeDefinition } from "../../resolver/types"; import { PlaygroundFileUploadForm } from "../form/PlaygroundFileUploadForm"; import { PlaygroundObjectPropertyForm } from "../form/PlaygroundObjectPropertyForm"; import { PlaygroundEndpointRequestFormState, PlaygroundFormDataEntryValue, PlaygroundFormStateBody } from "../types"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; interface PlaygroundEndpointMultipartFormProps { endpoint: ResolvedEndpointDefinition; diff --git a/packages/ui/app/src/playground/utils/auth-headers.ts b/packages/ui/app/src/playground/utils/auth-headers.ts index 64c9c92903..d35ad20da0 100644 --- a/packages/ui/app/src/playground/utils/auth-headers.ts +++ b/packages/ui/app/src/playground/utils/auth-headers.ts @@ -1,4 +1,5 @@ -import { APIV1Read, visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; +import { APIV1Read } from "@fern-api/fdr-sdk"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { decodeJwt } from "jose"; import { noop } from "ts-essentials"; import { PlaygroundAuthState } from "../types"; diff --git a/packages/ui/app/src/playground/utils/default-values.ts b/packages/ui/app/src/playground/utils/default-values.ts index 0311db6899..2c41fef1f9 100644 --- a/packages/ui/app/src/playground/utils/default-values.ts +++ b/packages/ui/app/src/playground/utils/default-values.ts @@ -1,4 +1,4 @@ -import { visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { ResolvedHttpRequestBodyShape, ResolvedObjectProperty, diff --git a/packages/ui/app/src/playground/utils/match-typeref.ts b/packages/ui/app/src/playground/utils/match-typeref.ts index 5a43b6243f..83f43e1b8f 100644 --- a/packages/ui/app/src/playground/utils/match-typeref.ts +++ b/packages/ui/app/src/playground/utils/match-typeref.ts @@ -1,4 +1,4 @@ -import { visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import { isPlainObject } from "@fern-ui/core-utils"; import { ResolvedObjectProperty, diff --git a/packages/ui/app/src/playground/utils/oauth.ts b/packages/ui/app/src/playground/utils/oauth.ts index 7ae16d9314..1bd1ed34e2 100644 --- a/packages/ui/app/src/playground/utils/oauth.ts +++ b/packages/ui/app/src/playground/utils/oauth.ts @@ -1,5 +1,5 @@ -import { APIV1Read, visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; -import { unknownToString } from "@fern-ui/core-utils"; +import { APIV1Read } from "@fern-api/fdr-sdk"; +import { unknownToString, visitDiscriminatedUnion } from "@fern-ui/core-utils"; import jsonpath from "jsonpath"; import { mapValues } from "lodash-es"; import { ResolvedEndpointDefinition } from "../../resolver/types"; diff --git a/packages/ui/app/src/search/content/FieldRecordV1.tsx b/packages/ui/app/src/search/content/FieldRecordV1.tsx index ab66e15e32..6f840795ee 100644 --- a/packages/ui/app/src/search/content/FieldRecordV1.tsx +++ b/packages/ui/app/src/search/content/FieldRecordV1.tsx @@ -1,4 +1,4 @@ -import { visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import type { Algolia } from "@fern-api/fdr-sdk/client/types"; import cn from "clsx"; import { LongArrowDownLeft } from "iconoir-react"; diff --git a/packages/ui/docs-bundle/src/server/withInitialProps.ts b/packages/ui/docs-bundle/src/server/withInitialProps.ts index 0a4af29390..b60ab644ab 100644 --- a/packages/ui/docs-bundle/src/server/withInitialProps.ts +++ b/packages/ui/docs-bundle/src/server/withInitialProps.ts @@ -1,5 +1,5 @@ import { getFeatureFlags } from "@/pages/api/fern-docs/feature-flags"; -import { visitDiscriminatedUnion } from "@fern-api/fdr-sdk"; +import visitDiscriminatedUnion from "@fern-ui/core-utils/visitDiscriminatedUnion"; import * as FernNavigation from "@fern-api/fdr-sdk/navigation"; import { SidebarTab } from "@fern-ui/fdr-utils"; import { getRedirectForPath } from "@fern-ui/fern-docs-utils"; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b4a6ec94f4..9b323a35b5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -875,6 +875,9 @@ importers: packages/fdr-sdk: dependencies: + '@fern-ui/core-utils': + specifier: workspace:* + version: link:../commons/core-utils dayjs: specifier: ^1.11.11 version: 1.11.11 @@ -890,6 +893,9 @@ importers: js-base64: specifier: 3.7.7 version: 3.7.7 + lodash-es: + specifier: '>=4' + version: 4.17.21 node-fetch: specifier: 2.7.0 version: 2.7.0 @@ -2426,6 +2432,9 @@ importers: '@fern-fern/fern-docs-sdk': specifier: 0.0.5 version: 0.0.5 + '@fern-ui/core-utils': + specifier: workspace:* + version: link:../../packages/commons/core-utils '@prisma/client': specifier: 5.13.0 version: 5.13.0(prisma@5.13.0) diff --git a/servers/fdr/package.json b/servers/fdr/package.json index 66f9798ca2..405c59d9c2 100644 --- a/servers/fdr/package.json +++ b/servers/fdr/package.json @@ -17,6 +17,7 @@ "@fern-api/template-resolver": "workspace:*", "@fern-api/venus-api-sdk": "^0.6.2-1-gbbd1ac5", "@fern-fern/fern-docs-sdk": "0.0.5", + "@fern-ui/core-utils": "workspace:*", "@prisma/client": "5.13.0", "@sentry/cli": "^2.31.0", "@sentry/node": "^7.112.2", diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.d.ts index 59fdf8862c..32f0a827a5 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/EndpointDefinition.d.ts @@ -2,7 +2,7 @@ * This file was auto-generated by Fern from our API Definition. */ import * as FernRegistry from "../../../../../../../index"; -export interface EndpointDefinition extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability { +export interface EndpointDefinition extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability, FernRegistry.api.latest.WithNamespace { id: FernRegistry.EndpointId; method: FernRegistry.HttpMethod; path: FernRegistry.api.latest.PathPart[]; diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.d.ts index d24ae27ea5..9d8dd05be1 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/ExampleEndpointCall.d.ts @@ -3,13 +3,13 @@ */ import * as FernRegistry from "../../../../../../../index"; export interface ExampleEndpointCall extends FernRegistry.api.latest.WithDescription { - name: string | undefined; path: string; - pathParameters: Record; - queryParameters: Record; - headers: Record; - requestBody: FernRegistry.api.latest.ExampleEndpointRequest | undefined; responseStatusCode: number; + name: string | undefined; + pathParameters: Record | undefined; + queryParameters: Record | undefined; + headers: Record | undefined; + requestBody: FernRegistry.api.latest.ExampleEndpointRequest | undefined; responseBody: FernRegistry.api.latest.ExampleEndpointResponse | undefined; - snippets: FernRegistry.api.latest.CodeSnippet[]; + snippets: Record | undefined; } diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.d.ts index 70f513a279..1b82d42cb9 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpRequestBodyShape.d.ts @@ -2,13 +2,13 @@ * This file was auto-generated by Fern from our API Definition. */ import * as FernRegistry from "../../../../../../../index"; -export declare type HttpRequestBodyShape = FernRegistry.api.latest.HttpRequestBodyShape.Object_ | FernRegistry.api.latest.HttpRequestBodyShape.Reference | FernRegistry.api.latest.HttpRequestBodyShape.Bytes | FernRegistry.api.latest.HttpRequestBodyShape.FormData; +export declare type HttpRequestBodyShape = FernRegistry.api.latest.HttpRequestBodyShape.Object_ | FernRegistry.api.latest.HttpRequestBodyShape.Alias | FernRegistry.api.latest.HttpRequestBodyShape.Bytes | FernRegistry.api.latest.HttpRequestBodyShape.FormData; export declare namespace HttpRequestBodyShape { interface Object_ extends FernRegistry.api.latest.ObjectType { type: "object"; } - interface Reference { - type: "reference"; + interface Alias { + type: "alias"; value: FernRegistry.api.latest.TypeReference; } interface Bytes extends FernRegistry.api.v1.read.BytesRequest { diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.d.ts index c18e868f6b..ba0d426a3e 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/endpoint/types/HttpResponseBodyShape.d.ts @@ -2,13 +2,13 @@ * This file was auto-generated by Fern from our API Definition. */ import * as FernRegistry from "../../../../../../../index"; -export declare type HttpResponseBodyShape = FernRegistry.api.latest.HttpResponseBodyShape.Object_ | FernRegistry.api.latest.HttpResponseBodyShape.Reference | FernRegistry.api.latest.HttpResponseBodyShape.FileDownload | FernRegistry.api.latest.HttpResponseBodyShape.StreamingText | FernRegistry.api.latest.HttpResponseBodyShape.Stream; +export declare type HttpResponseBodyShape = FernRegistry.api.latest.HttpResponseBodyShape.Object_ | FernRegistry.api.latest.HttpResponseBodyShape.Alias | FernRegistry.api.latest.HttpResponseBodyShape.FileDownload | FernRegistry.api.latest.HttpResponseBodyShape.StreamingText | FernRegistry.api.latest.HttpResponseBodyShape.Stream; export declare namespace HttpResponseBodyShape { interface Object_ extends FernRegistry.api.latest.ObjectType { type: "object"; } - interface Reference { - type: "reference"; + interface Alias { + type: "alias"; value: FernRegistry.api.latest.TypeReference; } interface FileDownload extends FernRegistry.api.latest.FileDownloadResponseBodyShape { diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.d.ts index 42be0fed01..b7cd09c7fe 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionType.d.ts @@ -3,6 +3,6 @@ */ import * as FernRegistry from "../../../../../../../index"; export interface DiscriminatedUnionType { - discriminant: string; + discriminant: FernRegistry.PropertyKey; variants: FernRegistry.api.latest.DiscriminatedUnionVariant[]; } diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.d.ts index e1156ecd3f..0cd6edeb3e 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/DiscriminatedUnionVariant.d.ts @@ -2,8 +2,7 @@ * This file was auto-generated by Fern from our API Definition. */ import * as FernRegistry from "../../../../../../../index"; -export interface DiscriminatedUnionVariant extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability { +export interface DiscriminatedUnionVariant extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability, FernRegistry.api.latest.ObjectType { discriminantValue: string; displayName: string | undefined; - additionalProperties: FernRegistry.api.latest.ObjectType; } diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.d.ts index 1a09c0df45..8a996373e2 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/type/types/FormDataRequest.d.ts @@ -3,6 +3,5 @@ */ import * as FernRegistry from "../../../../../../../index"; export interface FormDataRequest extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability { - name: string; fields: FernRegistry.api.latest.FormDataField[]; } diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.d.ts index 7adcea46ab..7ca06fb236 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/webhook/types/WebhookDefinition.d.ts @@ -2,11 +2,11 @@ * This file was auto-generated by Fern from our API Definition. */ import * as FernRegistry from "../../../../../../../index"; -export interface WebhookDefinition extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability { +export interface WebhookDefinition extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability, FernRegistry.api.latest.WithNamespace { id: FernRegistry.WebhookId; method: FernRegistry.api.latest.WebhookHttpMethod; path: string[]; - headers: FernRegistry.api.latest.ObjectProperty[]; - payload: FernRegistry.api.latest.WebhookPayload; - examples: FernRegistry.api.v1.read.ExampleWebhookPayload[]; + headers: FernRegistry.api.latest.ObjectProperty[] | undefined; + payload: FernRegistry.api.latest.WebhookPayload | undefined; + examples: FernRegistry.api.v1.read.ExampleWebhookPayload[] | undefined; } diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.d.ts index 4dc0b65e46..1741f549c6 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/ExampleWebSocketSession.d.ts @@ -3,10 +3,10 @@ */ import * as FernRegistry from "../../../../../../../index"; export interface ExampleWebSocketSession extends FernRegistry.api.latest.WithDescription { - name: string | undefined; path: string; - pathParameters: Record; - queryParameters: Record; - requestHeaders: Record; - messages: FernRegistry.api.latest.ExampleWebSocketMessage[]; + name: string | undefined; + pathParameters: Record | undefined; + queryParameters: Record | undefined; + requestHeaders: Record | undefined; + messages: FernRegistry.api.latest.ExampleWebSocketMessage[] | undefined; } diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.d.ts index 7100e42dc7..7c7257ac19 100644 --- a/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.d.ts +++ b/servers/fdr/src/api/generated/api/resources/api/resources/latest/resources/websocket/types/WebSocketChannel.d.ts @@ -2,7 +2,7 @@ * This file was auto-generated by Fern from our API Definition. */ import * as FernRegistry from "../../../../../../../index"; -export interface WebSocketChannel extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability { +export interface WebSocketChannel extends FernRegistry.api.latest.WithDescription, FernRegistry.api.latest.WithAvailability, FernRegistry.api.latest.WithNamespace { id: FernRegistry.WebSocketId; path: FernRegistry.api.latest.PathPart[]; /** The messages that can be sent and received on this channel */ diff --git a/servers/fdr/src/services/algolia/AlgoliaSearchRecordGenerator.ts b/servers/fdr/src/services/algolia/AlgoliaSearchRecordGenerator.ts index acfa0fc9be..ea437e6bcd 100644 --- a/servers/fdr/src/services/algolia/AlgoliaSearchRecordGenerator.ts +++ b/servers/fdr/src/services/algolia/AlgoliaSearchRecordGenerator.ts @@ -6,11 +6,10 @@ import { DocsV1Read, FernNavigation, convertDbAPIDefinitionToRead, - titleCase, visitDbNavigationTab, - visitDiscriminatedUnion, visitUnversionedDbNavigationConfig, } from "@fern-api/fdr-sdk"; +import { titleCase, visitDiscriminatedUnion } from "@fern-ui/core-utils"; import grayMatter from "gray-matter"; import { noop } from "lodash-es"; import { v4 as uuid } from "uuid"; diff --git a/servers/fdr/src/services/algolia/AlgoliaSearchRecordGeneratorV2.ts b/servers/fdr/src/services/algolia/AlgoliaSearchRecordGeneratorV2.ts index 6e5a8bf22f..a8e0e52536 100644 --- a/servers/fdr/src/services/algolia/AlgoliaSearchRecordGeneratorV2.ts +++ b/servers/fdr/src/services/algolia/AlgoliaSearchRecordGeneratorV2.ts @@ -7,11 +7,10 @@ import { FernNavigation, convertDbAPIDefinitionToRead, kebabCase, - titleCase, visitDbNavigationTab, - visitDiscriminatedUnion, } from "@fern-api/fdr-sdk"; import { EndpointPathPart } from "@fern-api/fdr-sdk/src/client/APIV1Read"; +import { titleCase, visitDiscriminatedUnion } from "@fern-ui/core-utils"; import { v4 as uuid } from "uuid"; import { BreadcrumbsInfo } from "../../api/generated/api"; import { LOGGER } from "../../app/FdrApplication"; diff --git a/servers/fdr/tsconfig.json b/servers/fdr/tsconfig.json index e49360dea2..bf9e5ba0c1 100644 --- a/servers/fdr/tsconfig.json +++ b/servers/fdr/tsconfig.json @@ -24,6 +24,9 @@ }, { "path": "../../packages/template-resolver" + }, + { + "path": "../../packages/commons/core-utils" } ] }